README.md

brc-analytics

Setup

Using Node.js version 20.10.0, run npm install in the root directory of the repository to install dependencies.

Using the development server

The app can be run for development using npm run dev, and accessed at http://localhost:3000.

Building the app locally

Run npm run build:local to build. The built app can be run using npm start, and accessed at http://localhost:3000.

BRC Analytics Data Catalog

Building the data source files

Create a Python virtual environment and install requirements:

python3 -m venv ./venv
source ./venv/bin/activate
pip install -r ./files/requirements.txt

Then run the script:

python3 ./files/build-genomes-files.py

The environment can be deactivated by running deactivate, and re-activated by running source ./venv/bin/activate again.

Building data files from the NCBI API

Using the Python environment described above, run the script:

python3 ./files/build-files-from-ncbi.py