BioStudies - Submission Tool

• Angular v10
• Bootstrap v4
• ExpressJS v4
• Node v10.16.2

Getting Started

1. Configure

This project uses config module which expects a .env file in the root directory.

Create a .env file in the root of the project and copy / pase the next environment variable definitions in it:

PORT = port;
BACKEND_PATH_CONTEXT = pathname;
BACKEND_HOST_NAME = hostname;
BACKEND_PORT = port;

• PORT is the service proxy (Node) port
• BACKEND_PATH_CONTEXT is the pathname of the backend service URL
• BACKEND_HOST_NAME is the hostname or backend URI
• BACKEND_PORT is the port where the backend is running

2. Install dependencies

Be sure your local environment has Node v10.16.2 and NPM v6.9.0 at least.

Run the next script to install dependencies:

 npm install

3. Run in development mode

Run the next script to execute the application in development mode:

npm run dev

• The npm run dev will run a Node + Express service which proxies the requests to BioStudies backend and an Angular Dev Server to get local development benefits (hot reload + live TS compilation)
• By default Node + Express service runs on 8080 port
• By default Angular Dev Server service runs on 4200 port
• If PORT is changed, it should be updated in the proxy.config.json file which is the Angular Dev Proxy configuration file

Run production mode

Make sure you have the .env file created as it's described in Getting Started - Configure

Run the next steps to build and execute the application in production mode:

npm run build
cp .env ./dist
cd ./dist
NODE_ENV=production node .

Tests

Run the next script to execute unit tests:

npm run test

Show general announcement

There is a handy feature to show general messages in the submission tool. If something needs to be announce to all the users a new Announcement banner is available in the app. The title, priority and description of the title are provided through environment variables.

To show the general announcement set the variables below in GitLab with the desired values. Please make sure you select an environment while setting the env vars otherwise the announcement will be visible in all environments. The priority value can be any of the available types for the Bootstrap Alert component.

APP_ANNOUNCEMENT_HEADLINE=Announcement title
APP_ANNOUNCEMENT_CONTENT=Announcement body
APP_ANNOUNCEMENT_PRIORITY=priority