An open API service indexing awesome lists of open source software.

https://github.com/lapp-coder/todo-app


https://github.com/lapp-coder/todo-app

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# REST API for todo list application ```v2.1.0```

***

### To run the application in docker:
```
$ make build && make run
```

### Before launching the application for the first time:

* Create a .env file in the root of the application with the following contents:

```
POSTGRES_PASSWORD=
SIGNING_KEY=
SALT=
TZ=
```

* Apply migrations to the database:

```
$ export POSTGRES_PASSWORD=
```

```
$ make migrate-up
```

### Use the following to create documentation:
```
$ make swag
```
### Documentation can be found at:
`http://:/swagger/index.html`

### You can also run the tests with the following command:
```
$ make test
```