New InterPro Web-Client

Requirements

• Node version 19+ (if not in your system, or lower version, see nvm, or install from node.js)

How to install

• Clone from this repo

• npm i (or npm install) to install all dependencies

• Create configuration file config.yml at the root of the project (see config.yml.example for an example)

Development

• npm run start to start the dev server

• Access the website at the address defined in your configuration

• There are 3 special branch names:

  • master: This branch should point the the code that is currently deployed in the Live machines.
  • dev: Use this branch for ready to test features. IT gets automatically deploys in the internal dev machine.
  • future: The new features in this branch require a new API release before they can be deployed.

• Other branches are considered feature branches that could eventually be merged into one of the above.

Other

You can check the list of possible commands by running npm run, and run them as stand-alone commands

Project structure

---

• scripts The scripts executed when various npm run options selected
• src The source code for the website
• tests Functional tests for the website