YALA - Yet Another Lunch App
Prerequisites:
- Node JS v22
- Postgres
You can install node using nvm or for example with homebrew.
If you installed node with nvm, run nvm use before installing or running project.
After installing node, run npm install to install project dependencies.
Then create a local environment file .env.local and copy the contents of .env into it.
Populate the file with your own values. To acquire the required variables,
create an application to Auth0 and get the values from there. Remember to also set
the callback url in the Auth0 dashboard since without it,
the authentication will fail. The default callback URL is http://localhost:3000/api/auth/callback
for local development.
Run project locally with npm run dev
Local postgres database is required for running the project. Running it in Docker is the easiest way usually.
docker run --name yala-postgres -e POSTGRES_PASSWORD=yala -p 5432:5432 -d postgresSwagger is available at /swagger-ui.
Swagger documentation is updated in post-install, so run npm install to update the documentation.
Playwright end to end tests are run on pull requests.
Check how install and run Playwright locally: https://playwright.dev/docs/intro