Page History
Table of Contents |
---|
Info | ||
---|---|---|
| ||
Background information on the DSpace 7 Release available at DSpace 7 UI Project Plain Language Summary. More information, including some FAQs available at DSpace Release 7.0 Status |
Note | ||
---|---|---|
| ||
DSpace 7 had a large presence at OR2019 in Hamburg, Germany, including two workshops and seven major talks. All the materials (slides, etc) and video recordings from OR2019 are available off the wiki page DSpace 7 at OR2019. Please note that workshops were not recorded, but all materials (slides / code examples) are linked off that page. On February 28, 2017, we held a DuraSpace Hot Topics webinar to discuss the latest activities of this Working Group, with details from both the Angular UI and REST API subteams. The slides and video of that Hot Topics webinar are available at http://duraspace.org/node/3103 We've also provided a high-level summary of current status (based on the webinar) at: DSpace 7 UI Project Plain Language Summary |
Scope & Objectives
The goal of this working group, led by Tim Donohue, is to create a new, single User Interface (UI) for DSpace that implements all functionality currently available in JSPUI and XMLUI. The UI will interact with DSpace core data through a completely new REST API to insure complete separation of the user layer from the data layer. This working group is split into two subteams: an Angular Subteam, led by Art Lowel (Atmire), which is concentrating on building a modern, responsive, client-side user interface using Angular and a REST API Subteam, led by Andrea Bollini (4Science), which is concentrating on building a new REST API based on state-of-art technologies, standards and best practices.
Deliverables
Info | ||
---|---|---|
| ||
Latest, high level status of DSpace 7 development is captured in our Development Planning Spreadsheet. This spreadsheet provides details on what features are considered completed (i.e. functional), in progress, and still remaining to do. |
Implementation of the User Interface and the REST API with code delivered on GitHub along with documentation on how to use, install, and extend the interface.
UIUser Interface: Angular (demo 5 | REST API: Java | |||
---|---|---|---|---|
Demo site: https://dspace7-demo.atmire.com/ | )Demo | REST API: Java (demo ) | ||
Angular Subteam is facilitated by Art Lowel (Atmire) | REST API Subteam is facilitated by Andrea Bollini (4Science) | Angular UI Code
Developer Resources
| REST API Subteam is facilitated by Andrea Bollini (4Science) REST API resources
REST Technology / Code
|
Training Resources
- REST API Resources
REST Contract
- OR2018 DSpace REST API Workshop
- Workshop Slides (including exercises): https://tinyurl.com/or2018-dspace-rest
- Exercises & online tutorial (work in progress): https://dspace-labs.github.io/DSpace7RestTutorial/
- OR2018 DSpace REST API Workshop
- Angular UI Resources
- DSpace 7 - Angular UI Development : Getting started with DSpace 7 UI (aka dspace-angular) and how to contribute
- DSpace 7 UI Technology Stack : Overview of technologies we are using, and links to third party resources
- OR2018 DSpace Angular Workshop: Angular UI Training Workshop resources from the OR2018 conference in Bozeman, Montana
- OR2017 DSpace Angular Workshop : Angular UI Training Workshop resources (slides and hands-on activities) from the OR2017 conference in Brisbane, Australia.
- The beginning of this workshop was also presented as a tutorial at the 2017 North American User Group meeting (at Georgetown University). Video of that tutorial is available at http://youtube.com/watch?v=c4AJ8HeZzcw
- Other DSpace
...
- Earlier brainstorms/discussion is also archived at REST API Contract (endpoints, functionalities, behaviour, etc.)
- 7 Presentations
June 2018: At OR2018, a DSpace 7 Update talk and demo was presented
- DSpace 7 Update Slides: https://tinyurl.com/or2018-dspace7 (Includes updates, What is coming in DSpace 7, estimated roadmap, and screenshots of the live demo)
- DSpace 7 Recorded Demo: https://youtu.be/yKnos2jTdSQ (Includes a preview of REST API, Browse, Search, and a detailed demo of the enhanced Submission & Workflow functionality. This is an extended version of the live demo given at OR2018 in conjection with the "DSpace 7 Update Slides")
June 2017: At OR2017 and the 2017 North American User Group meeting, updates on DSpace 7 efforts were presented. The slides from those talks are available:
- North American UG (August) update: https://goo.gl/cwKVkj
- OR2017 update (July): https://www.slideshare.net/tdonohue/on-the-road-to-dspace-7-angular-ui-rest
February 28, 2017: We held a DuraSpace Hot Topics webinar to discuss the latest activities of this Working Group, with details from both the Angular UI and REST API subteams. The slides and video of that Hot Topics webinar are available at http://duraspace.org/node/3103
Contributing
- Code Contributions: Generally, our working group follows the documented DSpace Code Contribution Guidelines and Code Style Guide.
- We also have our own DSpace 7 Working Group Processes document to provide additional details about our meeting structure, code contribution & review processes, etc.
- Join one of our weekly meetings (see below). Meetings tend to be hands-on, but we welcome newcomers.
- Developers are welcome to jump in and claim tickets for either Angular UI or REST API. We maintain a list of easier tickets specifically for new developers to learn about the contribution process (If none of these tickets look interesting, or the list is getting small, please get in touch and we'll find an easy task for you to start with)
- DSpace 7 Community Sprints : We run regular, public development sprints with anyone who wants to contribute. No prior experience with DSpace 7 is necessary, and it's a great opportunity to learn DSpace 7 in a "hands on", collaborative environment (Sprint Coaches are available for questions).
- Get in touch with the team via Slack. We'd be glad to talk about other ways to contribute
Meeting Times & Communication Channels
- Meetings: We meet every week on Thurs at 15:00UTC (11am EDT), alternating (every other week) between text chat meetings (on Slack) and Google Hangouts. Anyone (see schedule below), using the DSpace Zoom Meeting Room (using Slack as a backchannel). Anyone is welcome to join these meetings.
- Upcoming schedule can be found on the DuraSpace DSpace Public Events Calendar (iCal , RSS Feedversion)
- Meetings typically last only one hour (first 1/2 hour concentrates on Angular UI updates/discussion, and the second 1/2 hour on REST API). We post a weekly reminder on our Slack channels (see below), along with a brief agenda.
- Meeting notes are all available below.
- Google HangoutsMeeting Room: https://hangoutslyrasis.googlezoom.comus/hangouts/_/atmire.com/dspace7 Please be aware our Google Hangouts attendee limit is 25 individuals. While we usually do not get close to that limit, if you have a larger team that wishes to attend, we ask that you consider calling in together (e.g. from a shared conference room). my/dspace (For telephone options, see DSpace Meeting Room)
- Slack: Between meetings, we encourage usage of Slack to keep in touch and ask questions. If you have not yet joined the DSpace Slack, you may request an invite. All are welcome on Slack.
- In Slack, we primarily use two channels:
- #angular-ui : For DSpace 7 (Angular) UI updates, discussions and/or questions.
- #rest-api : For DSpace 7 REST API updates, discussions and/or questions.
- In Slack, we primarily use two channels:
- Email: We use standard DSpace lists to communicate updates, meetings, etc. Early on, we We are primarily using dspace-devel (our developers mailing list) and Slack for these communications. Once we get further along, regular updates will also be announced on dspace-community (and other lists).
The facilitator for the Angular 2 UI subteam is: Art Lowel (Atmire)
The facilitator for the new REST API subteam is: Andrea Bollini (4Science)
How to install locally
Please be aware that this all is work in progress and will change often. As we did not release any version (neither an alpha or beta version) yet, there is no stable state to which we can refer to. Nevertheless let us give you some short hints on what you can do to install your own local version:
- Install DSpace 6, create some communities, collections and archive some items. As DSpace 7 is still work in progress it will be good to have some test material in place.
- Shutdown you servlet container and undeploy all previous DSpace UIs
- Compile the current master (https://github.com/DSpace/DSpace/tree/master) and run ant update as usual
- Deploy the webapp dspace-spring-rest as dspace-spring-rest (if you use another path, you may want to change the index.html file withing the webapp)
- Start your servlet container and take a look into its logfiles
- If you have problems deploying the webapp in cause for slf4j and log4j, it may be necessary to delete [dspace]/webapps/spring-rest/WEB-INF/lib/slf4j-log4j12-1.7.22.jar
- Test if dspace-spring-rest was loaded successfully by opening it in a browser. You can compare it to the demo linked above.
- Install dspace-angular. You can try it as described in the OR2017 DSpace Angular Workshop or take a look into the Readme.md in the dspace-angular git repository.
Next Meeting
Next Meeting
Meetings are every Thursday (except where noted in agendas) Thursday, September 7 from 15:00-16:00 UTC (10am-11am -12pm EDT) in Google Hangouts: EST) in https://hangoutslyrasis.googlezoom.comus/hangouts/_/atmire.com/dspace7
- Discussion / approval of Search Mockup
- Updates on latest efforts (either Angular UI or REST API)
Meeting Notes
...
...
August 28, 2017 (rescheduled from Aug 24)
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
my/dspace (Meeting ID: 502 527 3040). Additional connection options (phone, etc) detailed at DSpace Meeting Room.
- Agenda & Connection Information can be found in the meeting notes below.
Meeting Notes
Children Display | ||||||||
---|---|---|---|---|---|---|---|---|
|
...