diff --git a/README.md b/README.md index fb80a56..8462026 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ # go-gin-gorm-books -CRUD Books with Gin and Gorm +This project is a CRUD Books where you can create, get all books, get a single book, update a book and delete a book. This project is for learning purposes. + +## Stacks +- Go +- Gin +- Gorm +- Viper +- PostgreSQL + + +## Prerequisites +1. Go +2. PostgreSQL (and a Database) + +## Installation +1. Clone this repo `git clone https://github.com/sumirart/go-gin-gorm-books.git` +2. Cd into the folder `cd go-gin-gorm-books` +3. `go install` +4. Rename the `.env.example` to `.env` in `pkg/common/envs` +5. Change the fill in `.env` which is port, DB user, DB password, DB server address and DB name + +## Usage +`make server` + +## License +[MIT](https://choosealicense.com/licenses/mit/)