summary refs log tree commit diff
path: root/README.md
blob: fa2e942679026c87e9918e5083a03b839aa860d9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-22041afd0340ce965d47ae6ef1cefeee28c7c493a6346c4f15d667ab976d596c.svg)](https://classroom.github.com/a/3A9ByVp3)

# Safe & Sound API

This is an API for allowing users with health issues to safely enjoy a theme park.
It provides freedom to people with health issues to enjoy the park while ensuring their safety and well-being.

Friendly reminder: clone the repository recursively!

# Deployment

Environment variables:
| Name | Default | Description |
| ---- | ------- | ----------- |
| `PORT` | `3000` | The port the server will run on. |
| `LOG_REQUESTS` | `-` | Requests to log to the console by status, `-` to invert. |
| `DATABASE_SECRET_PATH` | ` ` | The path to the mongodb connection string. |
| `JWT_SECRET_PATH` | ` ` | The path to the JWT secret certificate. |
| `LOG_QUERIES` | `false` | Whether to enable mongoose debug logs |
| `LOG_AUTH` | `false` | Whether to enable authentication debug logs |