Food System Digital Twin Website

Installation and Usage

The steps below will walk you through setting up your own instance of the project.

Install Project Dependencies

To set up the development environment for this website, you'll need to install the following on your system:

• Node (see .nvmrc) (To manage multiple node versions we recommend nvm)
• Yarn package manager
• Docker

Initialize .env.local File

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.

Install Application Dependencies

If you use nvm, activate the desired Node version:

nvm install

Install Node modules:

yarn install

Start development database with Docker:

docker-compose up

Migrate the database:

yarn migrate

Download 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 seed

Start development server:

yarn dev

✨ You can now access the app at http://localhost:3000

API Docs

This app uses Swagger to generate API docs. To access it, run the server and visit:

• http://localhost:3000/docs/api

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.

License

MIT