- npm v10.2.4
- node v20.10.0
- docker
- docker-compose
- nest-cli
This project runs three containers for local development.
In order to avoid cors errors during development we are running a reverse proxy on an nginx server.
Running The Project:
- ensure your node and npm version match those listed in the dependencies
- If it's the first time running the application:
cp .env.example .env cd frontend && npm icd backend && npm imake build-local
Local Dev Containers:
- Nginx Reverse Proxy: http://localhost:3050
- Frontend/React: http://localhost:3050
- Backend/NestJS: http://localhost:3050/api
- Keycloak: http://localhost:8080
- Postgres: http://localhost:5432
A default realm and client have been set up.
To login to the master realm:
- username: "admin"
- password: "password"
To login to the local client:
- username: "local-user"
- password: "admin"
In order to import existing TEAMS members, we have written scripts to translate data from the Master Excel spreadsheet currently in use as of March, 2024 to manage TEAMS rosters and deployments into our system. Our script pulls each relevant row from the spreadsheet and creates INSERT SQL statements to be ran into a database.
To use and install TSLab, follow the instructions here. The Jupyter Notebook can be opened under the notebooks directory. This will require an xlsx file named teamsmembers.xlsx in the notebooks directory.
In order to run migrations locally, run make migration-run, followed by make seed-data