- Creates scaffold for router and server - Main program set up for environment, OS signal listener - Makefile generic commands
18 lines
545 B
Markdown
18 lines
545 B
Markdown
# supermarket-api
|
|
|
|
Supermarket-API is a service providing functionality for cataloging produce and their prices.
|
|
|
|
## Getting Started
|
|
|
|
To start `supermarket-api` you will need to create an `.env` file at `cmd/api/.env`. A convenience example with sane defaults is located at `cmd/api/example.env` and you can create your environment file by running:
|
|
|
|
```
|
|
~$ cp cmd/api/example.env cmd/api/.env
|
|
```
|
|
|
|
Supermarket-API has a Makefile with commonly ran commands. To use the Makefile append the command to `make` in your terminal:
|
|
|
|
```
|
|
~$ make run
|
|
```
|