Summary
Project |
DSpace ClientUI built on RESTful API |
Student |
|
Mentors |
|
Technologies |
DSpace REST |
Proposal |
|
Location for project |
|
Notes |
Requirements
- Client run interface
- Attractive look and feel
- Easy to customize
Functional Specifications
Features to be supported
- Respository Browsing
- Repository Manipulation
- Content Searching
- Statistics
- Administration
Customizations to be supported
- Stylesheets (CSS)
- Layout
- Themes
- Internationalization
Project Timeline
|
Ready |
|
In Progress |
Before May 24
- Obtain access to :
- Wiki
- Project repository
- Download, build and install local DSpace instance
- Download, build and install DSpace REST module
- Test and verify the installation
- Go through the functionality of DSpace and DSpace REST API
- Compare possible JavaScript UI frameworks -- Ext JS preferred
Mark: I would like to see a bit more dialog with Bojan concerning the REST API contracts and migration to Spring, mainly, are we happy with these API contracts and using them for the students project, or do we need to consider some possible changes int he API to adopt to using Spring REST instead of Entity Broker. And if so, is there a timeline for providing those changes in scope of the 1.8 release?
Vibhaj: Confirmed that the possible migration shall not affect the REST interface and hence RestClient project.
May 25 - June 15
- Get familiar with REST API
- collections, communities, items and bitstreams
- create
- view
- edit
- delete
- users and groups
- view
- search
- generating statistics
- collections, communities, items and bitstreams
- Decide the JavaScript Library to be used by discussing with the DSpace community from among the following
jQuery [decided by community]
- Ext JS
- JxLib
- UIZE
- MochaUI
- Dojo Toolkit
- Learn the jQuery JavaScript Library
- Selectors
- Actions and Methods
- Events
- UI Widgets
- Design architecture for client run ServiceClient supported by RESTful (JSON) services
- Implement in jQuery
- Design generic Views, Renderers, Templates and Modules for ServiceClient
- Implement in jQuery
- Plan these extensions for RestClient
June 15 - June 30
- Implement extensions to ServiceClient to provide support for :
- Repository Browsing and Manipulation
- Communities
- Collections
- Items
- Bitstreams
- Content Searching
- Administration
- Groups
- Users
- Statistics
- Reports
- Charts and Visualization
- Repository Browsing and Manipulation
July 01 - July 15
- Testing
- Partial documentation
- GSoC Mid Term Evaluations
July 16 - July 31
- Enhancing the look and feel
- Look into and improve scope for customizations
- Stylesheets (CSS)
- Layout
- Themes
- Internationalization (jQuery support required)
- Improve the architecture of RESTClient and ServiceClient
Timeline shall be completed as project progresses ...