-
npm run dev
Builds the project (watching for changes) and starts a development server. -
npm run build
Builds the project.
-
npm run start
Runs the project in production mode. Compile withnpm run build
script first. -
npm run lint
Runs eslint.
npm run test
Runs tests.
Before running the API server, generate a TLS certificate with OpenSSL, ensuring that the output paths match the cert/key file variables set in .env
:
openssl req -newkey rsa:2048 -nodes -keyout tls/key.pem -x509 -days 365 -out tls/cert.pem
Above outputs:
tls/cert.pem
(TLS_CERT_FILE)tls/key.pem
(TLS_KEY_FILE)
To run the API server, navigate to the api/
directory and run npm run dev
. The server will start at https://localhost:9000.
Requires environment variables to be configured (see api/.env.example
).
For additional info, see api/README.md
.
To run the React client, enter the client/
directory and run npm run dev
. The client server will then run on http://localhost:3000.
Requires environent variables to be configured (see api/.env.example).