covid-tracker-backend-api

KO | EN

gitlite — search

#python #javascript #rust #react #machine-learning #css #typescript #sql #java #android #golang #nextjs

covid-tracker-backend-api

★ 72 Open GitHub ↗

COVID Tracker backend API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Contact Tracing API Service

### Set up Backend API

The backend API consists of both a Fastify server and a PostgreSQL database. To get these running will require the following steps. You will need Docker installed to run the database.

- Install the dependencies and create a basic environment configuration.

```bash
npm install
npm run create:env
```

- Next, start the database. This will download and install the PostgreSQL container.

```bash
npm run db:up
```

- If this is your first time running the database, you have previously deleted it, or migrations have been added, you will need to run migrations.

```bash
npm run db:migrate
```

- Finally, start the server in development mode.

```bash
npm run start:dev
```

### Backend API Development

There are a number of handy commands you can run to help with development.

|Command | Action |
|---|---|
|`npm run start:dev` | Run the server in dev mode, automatically restarts on file change |
|`npm run create:env`| Create a new .env file |
|`npm test`| Run unit tests |
|`npm run test:watch`| Run backend tests in watch mode, running on changed test files |
|`npm run db:migrate`| Run database migrations. |
|`npm run db:up`| Run the database server |
|`npm run db:down`| Shutdown the database server |
|`npm run db:delete`| Delete the database server. You will need to run `db:up` and `db:migrate` again. |
|`npm run lint`| Run eslint |
|`npm run lint:fix`| Run eslint in fix mode |

covid-tracker-backend-api

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README