Skip to content

irfnd/go-buks

Repository files navigation

Go-buks API

A simple API to manage book lists, using Fiber and PostgreSQL.

Go

Tech Stacks

Run Locally

Clone the project

git clone https://github.com/irfnd/go-buks

Go to the project directory

cd go-buks

Install dependencies

go mod download && go mod verify

Setup Database

cd database
docker-compose up -d

Copy .Env

cp .env.example .env

Start the server

go run .

API Docs

You can view the API documentation at http://localhost:8080/docs

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  • Fork the Project
  • Create your Feature Branch git checkout -b feature/AmazingFeature
  • Commit your Changes git commit -m '[Add] - some AmazingFeature
  • Push to the Branch git push origin feature/AmazingFeature
  • Open a Pull Request

License

Distributed under the MIT License.