Bionamic REST API

Includes the code for Bionamics REST API and client SDK

Installation guide

1. Install node.js at least version 20.8.0
2. Install postgresql at least version 13.12.0

Folder structure

project
|
|___src
    |
    |___database
    |
    |___scripts
    |
    |___utils

Scripts

Application scripts

Compiles the typescript code to javascript and outputs the code to dist folder in the root

npm run build

Starts the server. The script must be called after "npm run build"

npm run start-server

Linter scripts

Triggers typescript to check for mismatched types

npm run check

Triggers rome to check mismatched formatting

npm run format-check

Triggers rome to fix mismatched formatting automatically

npm run format-apply

Database scripts

Creates database with given name

npm run create-database -- databaseName

Creates all required tables for given database

npm run create-schema -- databaseName

Inserts test data for given database

npm run populate-database -- databaseName

code: "create-database": "npx ts-node src/scripts/create-database.ts", "create-schema": "npx ts-node src/scripts/create-schema.ts", "populate-database": "npx ts-node src/scripts/populate-database.ts", "intialize-database": "npx ts-node src/scripts/initalize-database.ts",

Startup

To start the server run the scripts below separately in same order

npm run build
npm run start