Code coverage: 93.68%
- Install all packages using npm/pnpm/yarn.
npm install
- Run all the services (postgresql, meilisearch, redis) using docker or if you have install directly on your machine then make sure all of the services are running.
docker compose up -d
- Setup your env file by copying the .env-sample to .env. Don't ever delete or rename the .env-sample. Create new file! Fill in all the relevant details.
- Run migrations and seeds.
npm run knex:migrate:latest
npm run knex:seed:run
- Run the app.
npm run dev
# or
npm run dev:watch #auto reload
We will not be running the app on Docker due to poor performance when reloading/restarting app in Docker Windows. Only db and other services will be on Docker.
- Running test
npm run test
- Test code coverage
npm run coverage
You can view the full api documentations on Postman or the openapi schema file in the docs folder.
| No | Route | Method | Query | Param | Body |
|---|---|---|---|---|---|
| 1 | / | GET | |||
| 2 | /restaurants | GET | open, limit | ||
| 3 | /restaurants/top | GET | min_price, max_price | ||
| 4 | /restaurants/search | GET | q | ||
| 5 | /purchases | POST | menu_id, user_id | ||
| 6 | /users/:id | GET | id |
