March 8, 2022: This project has been moved to Sage-Bionetworks/challenge-registry.
TBA
Clone this repository, as well as the two linked repositories. This can be
done with the --recursive flag.
git clone --recursive https://github.com/Sage-Bionetworks/rocc-app.git
Refer to Updating a Linked Repository section below if you need to update one or more of the linked repositories.
Create the configuration file.
cp .env.example .env
Go to the ROCC API service and retrieve the service images.
docker compose pull
Come back to this repo and start the ROCC app.
docker compose up --build
This section describes how to start the ROCC API service and the ROCC Angular app in development environment. After each step, you need to come back to the project root folder.
Clone this repository, along with the linked repositories.
git clone --recursive https://github.com/Sage-Bionetworks/rocc-app.git
Install the dependencies.
npm ci
Start the ROCC API service using Python on http://localhost:8080/api/v1
Start the web client (uses Angular CLI).
npm start
The ROCC app is dependent on two linked repositories (a.k.a. submodules):
When an update is pushed to one or more of the linked repository(ies), you will need to update those references on your end as well. The steps are:
Pull the latest changes, which will also fetch the updates made to the configuration files for the linked repos.
git checkout main git pull
Pull in the upstream changes from the linked repo's remote.
git submodule update
(optional) If new packages have been added to the client, those packages will need to be installed.
npm ci
To test, start the web client.
npm start
Run ng serve for a dev server. Navigate to http://localhost:4200/. The app
will automatically reload if you change any of the source files.
To add a new page to the web client, both an Angular component and module will need to be created:
ng generate c pages/<new page name>
ng generate m pages/<new page name>This will add a new sub-folder to the src/app/pages/ and will include 5 files:
<new page name>.component.html<new page name>.component.scss<new page name>.component.spec.ts<new page name>.component.ts<new page name>.module.tsA new TypeScript file will also need to be manually created within the sub-folder
called index.ts, so that both the component and module are exported, e.g.
export * from './<new page name>.component';
export * from './<new page name>.module';Routing within the ROCC app is found within src/app/app-routing.module.ts. Edit
any paths as needed.
To add a new route, use the following structure:
{
path: '<some new path>',
loadChildren: () => import('./pages/<new page name>').then(m => m.<NewPageName>),
canActivate: [AuthGuard]
}Please remember that the routing order does matter. We follow Angular's standard of more-specific first, less-specific later; that is, paths with static routes are placed first, followed by paths with parameters.
rocc-app is utilizing a shared component from the sage-angular library for
its navigation bar. To edit the navbar contents, e.g. the links displayed, navigate
to src/app/app-section.ts and modify as needed.
To add a new section, use the following structure:
<new path name>: {
name: '<text to be displayed',
summary: '<description of the path'
}Run ng generate component component-name to generate a new component. You can
also use ng generate directive|pipe|service|class|guard|interface|enum|module.
Run ng build to build the project. The build artifacts will be stored in the
dist/ directory. Use the --prod flag for a production build.
Run ng test to execute the unit tests via Karma.
Run ng e2e to execute the end-to-end tests via Protractor.
To get more help on the Angular CLI use ng help or go check out the
Angular CLI Overview and Command Reference page.