Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/adrienemery/auv-control-api

API for AUV database backend
https://github.com/adrienemery/auv-control-api

Last synced: 9 days ago
JSON representation

API for AUV database backend

Awesome Lists containing this project

README

        

# auv-control-api

This is main API code for managing AUV's, planning trips, logging data.

## Development

### With Docker

```bash
$ docker-compose build
$ docker-compose run web python manage.py migrate
$ docker-compose run web python manage.py createsuperuser
$ docker-compose up
```

### Without Docker

#### Install Dependencies
```bash
$ pip install -r requirements.tx
```

#### Setup enviornment variables

```bash
$ export DEBUG=True
$ export DATABASE_URL=postgres://USER:PASSWORD@HOST:PORT/NAME`
$ export SECRET_KEY=somethingsecret
```

For other database backends see:
https://github.com/kennethreitz/dj-database-url

#### Run migrations
```bash
$ python manage.py migrate
```

#### Create Superuser
```bash
$ python manage.py createsuperuser
```

#### Run Development Server
```bash
$ python manage.py runserver
```

#### Create AUV
Go to `localhost:8000/admin` and create an AUV for testing with the Frontend.