README.md

ODE-APP

Web Pipeline For Kinetic (ODE-Based) Models.

Development

This project uses StandardJS for styling, linting and formatting purposes. Please find more documentation related to that here.

The app consists of 2 components; the React Client and Backend Node server. All the react components go into the src folder where as the backend has its independent folders for controllers and api routes.

Follow the below instructions to get the app up and running:

• You need Node & Yarn to run this application. Download them here - Node, Yarn. Further you also need a server of a postgresql database running. Learn more about postgresql here.

• First you will need to install the dependencies of the project. Do that by running this:

  yarn

• Next you have to setup an environment file (.env) with appropriate variables, an example .env would look like this:

  SERVER_PORT = /* Specifiy a port here */
  DB_NAME = /* Your database name */
  DB_USER = /* Your database user */
  DB_PASSWORD = /* Your database user's password */

• Then run the following command to start the React Client and Node server simultaneously:

  yarn dev

Other Scripts

• To run the node server independently, use:

  yarn server

• To run the react client independently, use:

  yarn client

• To run tests on the react client, use:

  yarn client-test

• To build a production react client, use:

  yarn client-build

• To eject the configuartion and scripts from the react-scripts package, use:

  yarn client-eject