Summary
Project |
DSpace ClientUI built on RESTful API |
Student |
|
Mentors |
|
Technologies |
DSpace REST |
Proposal |
|
Repository |
|
Demo |
http://ec2-107-20-35-121.compute-1.amazonaws.com:8080/restclient/ |
Notes |
Project Requirements
- Client run interface
- Attractive look and feel
- Easy to customize
Features
DSpace REST |
Built on the DSpace REST API developed as GSoC project in 2009-10 |
FireSpark |
Interface powered by FireSpark - JavaScript Service Computing Platform - which |
RESTClient Extensions |
Services and Workflows built for RESTClient using FireSpark for providing core |
jQuery Templates |
Client side processing supported by flexible templates written in JavaScript |
CKEditor |
HTML Rich Text Editor supported for easier text input during repository |
User Documentation
Directory Structure
Customizations
Developer Documentation
Screenshots
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 |
|
Base done, Improvement phase |
|
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 DSpace 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: jQuery [decided by community]
Learn the jQuery JavaScript Library
Selectors
Actions and Methods
Events
UI Widgets
Design client run FireSpark framework supporting JavaScript UI for RESTful (JSON) services
Design generic Services and Workflows in FireSpark
Plan these extensions for RestClient
RESTUI.Resource.Load Workflow
RESTUI.Resource.Edit Workflow
RESTUI.Resource.Delete Workflow
ParseItemMetadata helper
June 15 - July 10
Implement extensions (Services and Workflows) to FireSpark in RESTClient to provide support for :
- Repository Browsing
- Communities
All
Single
Subcommunities
Recent Submissions
- Sort
- Collections
All
Single
- Sort
- Items
All
Single
Read Metadata
- Bitstreams
Download
- Communities
- Repository Browsing
July 11 - July 15
GSoC Mid Term Evaluations
July 15 - July 31
Implement extensions (Services and Workflows) to FireSpark in RESTClient to provide support for :
- Repository Manupulation
- Communities
Edit
Delete
- Collections
Edit
- Communities
- Administration
- Users
Login
Logout
All
Single
- Groups
All
Single
- Users
- Content Searching
- Statistics
Reports (simple)
Charts and Visualization (simple)
- Repository Manupulation
August 1 - August 15
- Enhancing the look and feel
- Look into and improve scope for customizations
- Improve the architecture of RESTClient and FireSpark
- Testing
- Complete Documentation
- Final Improvements