https://github.com/evscott/aedibus-api-old
To see this projects Kanban board install the Zenhub Chrome/Firefox extension.
https://github.com/evscott/aedibus-api-old
Last synced: 5 months ago
JSON representation
To see this projects Kanban board install the Zenhub Chrome/Firefox extension.
- Host: GitHub
- URL: https://github.com/evscott/aedibus-api-old
- Owner: evscott
- Created: 2019-11-09T00:43:16.000Z (over 6 years ago)
- Default Branch: development
- Last Pushed: 2020-01-05T07:44:15.000Z (over 6 years ago)
- Last Synced: 2025-02-05T18:25:35.196Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 220 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# aedibus-api
### Prerequisites
1. Ensure that you have [go](https://golang.org/) installed.
2. Ensure that you have [docker](https://www.docker.com/) installed.
3. Ensure that you have [docker-compose](https://docs.docker.com/compose/install/) installed.
### Installing
To run the API without Docker you have to install its dependencies. Inside of the api root directory, run:
```
go get ./...
```
*Note: the API requires a database connection to successfully boot*
## How to use
### Run the application with docker-compose
Inside of the api root directory, run:
```
docker-compose down && sudo docker-compose up --build
```
### Clean database history
Inside of the api root directory, run:
```
sudo rm -rf postgres-data
docker volume prune
docker rm $(docker ps -a -q)
```
## Architecture
### API
*Note: this diagram is a rough draft and omits many details*
### DB
## Authors
* **[Eliot Scott](https://github.com/evscott)** - *Initial work*
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.