Page History

Scope & Objectives

The goal of this working group is , 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 interface UI will interact with DSpace core data through the a completely new REST API to insure complete separation of the user layer from the data layer. It will be built as a modern responsive client side web application using Angular 2.

Deliverables

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

Implementation of the User Interface Implementation of the interface and the REST API with code delivered on GitHub along with documentation on how to use, install, and extend the interface.

Training Resources

• REST API Resources
  • 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/ 
• 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 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)
  • REST API tickets labeled "easy"
  • Angular UI tickets labeled "difficulty: low"
• 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 (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 DSpace Public Events Calendar (iCal version)
  • Meetings typically last one hour. We post a weekly reminder on our Slack channels (see below), along with a brief agenda.
  • Meeting notes are all available below.
  • Meeting Room: https://lyrasis.zoom.us/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.
• Email: We use standard DSpace lists to communicate updates, meetings, etc. 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).

Next Meeting

Meetings are every Thursday (except where noted in agendas) from 15:00-16:00 UTC (10am-11am EST) in https://lyrasis.zoom.us/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

...

REST Contract 

• Early discussion has begun at REST API Contract (endpoints, functionalities, behaviour, etc.)

...

Frequency of meetings will be every other week, unless modified by the facilitator.  Initial meetings may be more frequent. The working group have two sub-area of interest, the angular 2 UI itself and the build of the new REST API. The meeting will typically run for two hours one dedicated to the Angular 2 UI aspects and one hour to the REST API. The community is welcome to attend one or both meetings as by their interest.

The group will use the standard DSpace lists to communicate about both areas.  When using a shared channel, start the subject line with “[new-UI]”, "[new-REST]" or something similar to distinguish content.

Meeting Notes are posted to the wiki below.

The facilitator for the Angular 2 UI is: Art Lowel (Atmire)

The facilitator for the new REST API is: Andrea Bollini (4Science)

Next Meeting

On January the 26th from 3 PM to 5 PM (UTC). Angular the first hour, REST the second.

Meeting Notes

...

November 15th 2016

...

December 1st 2016

...