gocoffee

GoCoffee

Coffee Management API

GoCoffee is your gateway to a world of coffee wonders. Crafted with passion and powered by Go, Go-Chi, PostgreSQL, and Docker, this API opens the door to a coffee experience like no other. Whether you're creating, updating, deleting, or exploring unique coffee varieties, GoCoffee brings the coffee world to your fingertips.

Table of Contents

• Features
• Technologies
• Getting Started
• Usage
• Contributing
• Deployment
• License

Features

• Streamlined coffee information management.
• Built with Go, utilizing the power of Go-Chi for robust routing.
• Uses PostgreSQL for data storage.
• User-friendly API endpoints for creating, updating, deleting, and fetching coffee details.
• Maintains a clean and organized codebase.

Technologies

Getting Started

Follow these steps to get GoEater up and running on your local machine:

1. Clone this repository:

   git clone https://github.com/vrtttx/gocoffee.git
   
   cd gocoffee
   

2. Install dependencies:

   go mod download
   

3. Build the applications:

   go build
   

4. Run:

   ./main
   

Usage

GoCoffee provides a RESTful API for efficient coffee information management.

After the API is running, you can use tools like Postman to interact with the endpoints for creating, updating, deleting, and fetching coffee details.

Contributing

Contributions are always welcome! Feel free to submit issues and pull requests.

To contribute to this project, please follow these guidelines:

1. Fork the repository
2. Create a new branch: git checkout -b feature/your-feature-name
3. Make your changes and commit them using Conventional Commits
4. Push to the branch: git push origin feature/your-feature-name
5. Submit a pull request

Author & Contributors

• @ynncstslv

License

This project is licensed under the MIT License - see the LICENSE file for details.