README
¶
heroku-starter-golang (WORK IN PROGRESS)
A dockerized starter project which deploys an golang CRUD app to heroku.
Deployed here on heroku https://heroku-starter-golang.herokuapp.com
Installation
Make sure Docker, make, nodejs (development only) and golang are installed
- Run
docker-compose upto start the postgres DB - Run
make local-setupto installnodemonand setup environment - Run
make startto run the migrations
Environment variables
| Name | Description |
|---|---|
| ENV | development/production |
| DB_USERNAME | Username of the postgres DB |
| DB_PASSWORD | Password of the postgres DB |
| DB_NAME | Name of the postgres DB |
| DB_HOST | Host of the postgres DB |
CI Secrets
| Name | Description |
|---|---|
| HEROKU_API_KEY | Heroku API key |
| HEROKU_APP_NAME | Heroku app name |
| HEROKU_EMAIL | Your email address on Heroku |
Migrations
This repo uses GORM for auto migration generation. The process is non-destructive.
Running
Run make start to start in development mode.
Import the ./postman/* into Postman to see the API docs
Documentation
¶
There is no documentation for this package.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.