The steps below will walk you through setting up your own instance of the project.
To set up the development environment for this website, you'll need to install the following on your system:
The project uses environment variables, which are set by default in the .env file. To customize these variables (e.g., to use a custom database), create a .env.local file at the root of the repository (cp .env .env.local) and modify as needed.
Note: .env.local is ignored by Git.
If you use nvm, activate the desired Node version:
nvm installInstall Node modules:
yarn installStart development database with Docker:
docker-compose upMigrate the database:
yarn migrateDownload the contents of this Google Drive folder and add it to a directory called ./app-data in the cloned repository.
Ingest downloaded data with:
yarn seedStart development server:
yarn dev✨ You can now access the app at http://localhost:3000
This app uses Swagger to generate API docs. To access it, run the server and visit:
The API docs page should be updated automatically after adding Swagger configuration as JSDoc in route files, as described in next-swagger-doc documentation.
To validate the documentation, please run yarn swagger:validate, which will check for errors and add the application version found in package.json.