No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docker
src
.gitignore
CONTRIBUTING.md
LICENSE
README.md
config.js
env_default
package-lock.json
package.json
webpack.config.js

README.md

Nexus Registration

Domain-agnostic data edition and registration web application for the Blue Brain Nexus platform.

Prerequisites for development

Node.js 8 or later npm 5 or later (Optional) Docker if you want to generate Docker images

How to use

Install

Inside the root folder of the application, type:

npm install

Configure (will not run properly otherwise)

Copy the file env_default to .env

cp env_default .env

Edit the file .env and put the values matching your Nexus instance endpoints and default domain, as well as the base path you want the application to be available under. Example:

BASE_PATH=/registration  # You want it under yourdomain.tld/registration
BASE_URI=https://bbp-nexus.epfl.ch/v0  # Nexus API endpoint to talk to
DOMAIN=bbp  # Default domain to open

Run tests

npm test

Build

npm run build

The compiled version of the application will be put into the dist/ folder.

Run locally

npm start

The application will be listening to http://127.0.0.1:3000

Do not forget to append the base path you configured in your .env file. Below is an example of full URL to access the application:

http://127.0.0.1:3000/registration

Use Ctrl+C to stop.

Build Docker image

Will build a Docker image ready to run the application off the nginx mainline Docker image.

npm run build-docker

The resulting image will be named nexus-registration-webapp:{current_version_number}

Run Docker image locally

After building the Docker image, you can run it locally with:

npm run start-docker

The application will be listening to http://127.0.0.1:8000

Do not forget to append the base path you configured in your .env file. Below is an example of full URL to access the application:

http://127.0.0.1:8000/registration

Use Ctrl+C to stop.