This page is for attendees of the OR2018 workshop "Getting Started with the DSpace 7 Angular UI". It provides links to resources, workshop preparation, etc. (This workshop was based on materials from the OR2017 DSpace Angular Workshop, but slides/materials/exercises have been updated.) |
There are no installation requirements for the workshop. However, as the second half of the workshop is a code walkthrough (of some live development / theme customizations), you can optionally choose to install the Angular UI locally (and perform "hands-on" changes on your laptop).
Please be aware that, as we currently have over 40 workshop attendees, we unfortunately cannot promise any "hands-on" support on an individual basis. But, we still welcome you to turn use this as an opportunity to try some "hands-on" changes.
During the code walkthrough, we will be working directly with the dspace-angular project (this is the in-development Angular UI for DSpace 7). However, don't worry. It's rather easy to install, and you do not need to install DSpace itself (as we will be using the public, demo REST API as our backend).
(These instructions are based on the dspace-angular README)
git clone https://github.com/DSpace/dspace-angular.git
(Pulls down the code into a dspace-angular folder on your local computer)cd dspace-angular
(Move into the newly created dspace-angular folder)yarn install
(Install all local dependencies via yarn)yarn run watch
(Build and startup the DSpace Angular UI, while watching code for new changes.)yarn start
", but that command requires you restart to pick up local code changes.That's it! Again, there is no need to have DSpace running or install a database, Java, Tomcat or any of the other usual DSpace prerequisites.
To follow along with the exercises run the following git commands in the project directory to get the correct starting point
git remote add workshop https://github.com/DSpace-Labs/dspace-angular-workshops.git
git fetch workshop (Pulls down the dspace-angular-workshops code locally)
git checkout or2018-start (Checks out the starting point of the workshop)
git checkout -b or2018-hands-on (Creates a local branch named "or2018-hands-on" for you
At certain points during the hands-on part we'll show a git tag that corresponds to the solution so far. If you'd like to sync up to that point, run the following:
Revert all existing files to their state at the start:
git reset or2018-start --hard
Remove any newly created files
git clean -f -d
Sync with the solution
git merge $TAG_NAME
While not required, the following tools may make it easier to do basic development with the Angular UI.