README
¶
bm-app
Development instructions
Getting started
- Install docker and docker-compose
- Install Node and npm
- Copy and setup variables in
.env$ cp .env.example .env- Then make any env changes you need
Running the server
$ make dev- Sets up the server and automatically recompiles on file changes
$ make test- Runs our test suite
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
internal
|
|
|
http/middleware
Package middleware provides functions to inspect and transform incoming requests before they're routed out to their corrrect handler.
|
Package middleware provides functions to inspect and transform incoming requests before they're routed out to their corrrect handler. |
|
mail
Package mail defines an interface through which mail can be sent.
|
Package mail defines an interface through which mail can be sent. |
|
mail/mailgun
Package mailgun provides a Mailer interface to send mail
|
Package mailgun provides a Mailer interface to send mail |
|
mail/mock
Package mock provides a Mailer interface to test sending mail.
|
Package mock provides a Mailer interface to test sending mail. |
|
models
Package models represents the objects and services that can modify them.
|
Package models represents the objects and services that can modify them. |
|
postgres
Package postgres provides a PostgreSQL specific implementation of the services we provide.
|
Package postgres provides a PostgreSQL specific implementation of the services we provide. |
|
s3/aws
Package mock provides a Mailer interface to upload files to AWS S3.
|
Package mock provides a Mailer interface to upload files to AWS S3. |
|
s3/mock
Package mock provides a S3 interface for uploading files.
|
Package mock provides a S3 interface for uploading files. |
|
pkg
|
|
|
env
Package env handles loading and reading environment variables from a file.
|
Package env handles loading and reading environment variables from a file. |
Click to show internal directories.
Click to hide internal directories.