iRegulon web-app

Required software

• Node.js 16.x, >=16.13
• MongoDB ^5.x

Getting started

N.b. you can use public service instances for your local development to obviate local service dependencies. See below for details.

• Windows Cloning

  • The public directory includes symlinks, which most versions of Windows Git will not correctly clone by default. Make sure to clone using the following command:
    • git clone -c core.symlinks=true https://github.com/cytoscape/iregulon-webapp.git

• Prerequisites:

  • Node.js
    • Option 1: Install nvm so you can have multiple versions of node installed.
      • Install version 16 with nvm install 16.
      • Set version 16 as your default: nvm alias default 16.
      • To use a particular version, do nvm use 16.0.1 or set up a .nvmrc file in the CWD and do nvm use.
    • Option 2: Install node manually:
      • Mac: brew install node@16
      • Linux: Use dnf, zypper, apt, etc.
      • Or use the installer for Mac or Windows
  • MongoDB
    • Mac: brew install mongodb-community && brew services start mongodb-community
    • Linux: Use dnf, zypper, apt, etc.
    • Or use the installer
    • Use MongoDB Compass for debugging

• Start off by running npm install.

• The main target you will run during development is npm run watch.

  • This automatically builds the clientside code in the background. The browser will refresh automatically when the code is rebuilt.
  • The server will automatically reload when you change the server code. That way new HTTP requests from the client will use the updated code right away.

• Dependent services:

  • MongoDB: If you have MongoDB running locally on the default port, you don't need to configure any environment variables to get things working. The defaults are preset for local development.
  • N.b. you can use public service instances for your local development to obviate local service dependencies. It is recommended to use a local instance of MongoDB, where possible, to avoid conflicts. You can use an .env file in the root of this project with the proper values for remote services. Do not commit the linked environment variables in public GitHub repositories.

• The Chrome debugger can be used for the clientside code (Chrome > View > Developer > Developer Tools) or the serverside code (npm run inspect and go to chrome://inspect). There is also an included launch config file that allows you to debug the client or the server directly in VSC.

Editor

• Visual Studio Code
• Extensions
  • Must-haves
    • ESLint : Lint JS.
    • Stylelint : Lint CSS.
    • Debugger for Chrome : Use the VSC debugger on an instnace of Chrome, for debugging the browser UI.
  • Nice-to-haves
    • GitHub Pull Requests and Issues : Easily browse and reference issues and pull requests.
    • Live Share Extension Pack : Do remote pair programming.
    • Docker : Manage docker images with a GUI.

Configuration

The following environment variables can be used to configure the server:

• NODE_ENV : the environment mode, either production or development (default)
• PORT : the port on which the server runs (default 3000)
• LOG_LEVEL : the log level for out.log
• BASE_URL : the base url of the server (e.g. https://example.com)
• IREGULON_JOB_SERVICE_URL : the full path of the iRegulon submitJob service
• IREGULON_STATE_SERVICE_URL : the full path of the iRegulon stateCheck service
• IREGULON_RESULTS_SERVICE_URL : the full path of the iRegulon results service
• MOTIF_RANKINGS_DATABASE : the name of the Motif Rankings database
• TRACK_RANKINGS_DATABASE : the name of the Track Rankings database
• MONGO_URL: the MongoDB connection URL
• MONGO_ROOT_NAME: the name of the app's DB in Mongo
• MONGO_COLLECTION_QUERIES: the name of the query collection
• SENTRY_ENVIRONMENT: the Sentry environment name to use (automatic in prod mode, set to test* like test_joe to get Sentry reports in debug instances)

Run targets

• npm start : start the server (usually for prod mode)
• npm run watch : watch mode (debug mode enabled, autorebuild, autoreload)
• npm run inspect : start the server in inspection mode, with server-side code debuggable via the chrome debugger with a breakpoint automatically set on the first line (chrome://inspect)
• npm run build : build project
• npm run build-prod : build the project for production
• npm run clean : clean the project
• npm run lint : lint the project
• npm run fix : fix linting errors that can be automatically addressed
• npm run test:mocha : run model tests
• npm test : run model tests, linting, and a build (run this before doing a pull request)

Running via Docker

Build the container. Here, iregulon is used as the container name.

docker build -t iregulon .

Run the container:

docker run -it -p 12345:3000 -e "NODE_ENV=production" --name "my-iregulon" iregulon

Notes:

• The -it switches are necessary to make node respond to ctrl+c etc. in docker.
• The -p switch indicates that port 3000 on the container is mapped to port 12345 on the host. Without this switch, the server is inaccessible.
• The -u switch is used so that a non-root user is used inside the container.
• The -e switch is used to set environment variables. Alternatively use --env-file to use a file with the environment variables.
• References:
  • Dockerizing a Node.js web app
  • Documentation of docker-node
  • Docker CLI docs

Testing

All files /test will be run by Mocha. You can npm run test:mocha to run all tests, or you can run npm run test:mocha -- -g specific-test-name to run specific tests.

Chai is included to make the tests easier to read and write.

By running npm test, you will run the tests, the linting, and a test build.

Publishing a release

1. Make sure the tests are passing: npm test
2. Make sure the linting is passing: npm run lint
3. Bump the version number with npm version, in accordance with semver. The version command in npm updates both package.json and git tags, but note that it uses a v prefix on the tags (e.g. v1.2.3).
4. For a bug fix / patch release, run npm version patch.
5. For a new feature release, run npm version minor.
6. For a breaking API change, run npm version major.
7. For a specific version number (e.g. 1.2.3), run npm version 1.2.3.
8. Push the release: git push origin --tags