https://github.com/imgabreuw/books-api

API Rest, made in Go, to manage your books.
https://github.com/imgabreuw/books-api

gin go-orm golang postgresql

Last synced: 22 days ago
JSON representation

API Rest, made in Go, to manage your books.

• Host: GitHub
• URL: https://github.com/imgabreuw/books-api
• Owner: ImGabreuw
• Created: 2021-07-18T21:22:44.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-07-18T23:43:33.000Z (almost 5 years ago)
• Last Synced: 2025-06-14T21:02:56.256Z (12 months ago)
• Topics: gin, go-orm, golang, postgresql
• Language: Go
• Homepage: https://youtu.be/socM14c9Vfk
• Size: 28.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# books-api

[![Author](https://img.shields.io/badge/author-ImGabreuw-00ADD8?style=flat-square)]()

[![Languages](https://img.shields.io/github/languages/count/ImGabreuw/books-api?color=00ADD8&style=flat-square)](#)

[![Stars](https://img.shields.io/github/stars/ImGabreuw/books-api?color=00ADD8&style=flat-square)](https://github.com/ImGabreuw/books-api/stargazers)

> API Rest, made in Go, to manage your books

### 📝 TODO

- [ ] Put database configuration in `.env` file

- [ ] API documentation

- [ ] Deploy

## 💻 Prerequisites

* Go 1.16+

* Your favorite IDE

## 💻 Technology

* Go

* Gin

* Go-ORM

* PostgreSQL

## 🚀 Installation

  

```bash

# Repository clone

$ git clone https://github.com/ImGabreuw/books-api.git

# Go to the application directory

$ cd books-api

# Start database

$ docker-compose up -d

# Run application

$ go run main.go

```

Go to http://localhost:5000/api/v1/books/

## 📫 Contribution

To contribute to **books-api**, follow these steps:

1. Fork this repository.

2. Create a branch: `git checkout -b feature/`.

3. Make your changes and confirm them: `git commit -m 'some description of feature'`

4. Send to the original branch: `git push origin `

5. Create the pull request.

Alternatively, refer to the GitHub documentation at [how to create a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).

## 🤝 Contributors

We thank the following people who contributed to this project:

  

    

      

        


        

          ImGabreuw

        

      

    

  

## 😄 Be one of the contributors


Want to be part of this project? Click [HERE](CONTRIBUTING.md) and read how to contribute.

## 📝 License

This project is under license. See the archive [LICENSE](LICENSE.md) for more details.

[⬆ Back to the top](#books-api)