first commit
This commit is contained in:
55
README.md
Normal file
55
README.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Project api-service
|
||||
|
||||
One Paragraph of project description goes here
|
||||
|
||||
## Getting Started
|
||||
|
||||
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
|
||||
|
||||
## MakeFile
|
||||
|
||||
Run build make command with tests
|
||||
```bash
|
||||
make all
|
||||
```
|
||||
|
||||
Build the application
|
||||
```bash
|
||||
make build
|
||||
```
|
||||
|
||||
Run the application
|
||||
```bash
|
||||
make run
|
||||
```
|
||||
Create DB container
|
||||
```bash
|
||||
make docker-run
|
||||
```
|
||||
|
||||
Shutdown DB Container
|
||||
```bash
|
||||
make docker-down
|
||||
```
|
||||
|
||||
DB Integrations Test:
|
||||
```bash
|
||||
make itest
|
||||
```
|
||||
|
||||
Live reload the application:
|
||||
```bash
|
||||
make watch
|
||||
```
|
||||
|
||||
Run the test suite:
|
||||
```bash
|
||||
make test
|
||||
```
|
||||
|
||||
Clean up binary from the last build:
|
||||
```bash
|
||||
make clean
|
||||
```
|
||||
creat swagger
|
||||
swag init -g cmd/api/main.go --output cmd/api/docs
|
||||
Reference in New Issue
Block a user