ConceptCodes / zoomies-api-go

Zoomies API 🐶

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

Welcome to the Pet Grooming API! This API provides a robust solution for pet owners, groomers, and administrators to manage pet grooming appointments seamlessly. It's designed to make pet grooming scheduling efficient and user-friendly.

(back to top)

Built With

• 
• 

Features

• User Registration and Authentication
• Pet Management
• Appointment Scheduling
• Groomer Availability Management (if applicable)
• Checkout Wiki for more details

What I Learned ?

(back to top)

Prerequisites

Before you begin, ensure you have met the following requirements:

• PostgreSQL (Recommended version: 13+)
• Golang (Recommended version: 1.16+)

Installation

To get this API up and running, follow these steps:

1. Clone the repo:

    git clone https://github.com/conceptcodes/zoomies-api-go.git

2. Navigate to the project directory:

   cd zoomies-api-go

3. Install dependencies:

    go get .

4. Configure environment variables:

   • Create a config.json file based on the provided example file.
   • Fill in the required configuration values.

   cp example.json config.json

5. Run DB Migration:

    go run ./migrations

6. Start the server:

   yarn dev

   If everything works as expected, you should see the following message in your terminal:

   =====================================================
   ================= ENV: local ========================
   ===== Zoomies Api listening on PORT: 8000 ===========
   =====================================================

7. Make a request to our health check endpoint:

   curl http://localhost:8000/api/health/alive

   you should see the following response:

   {
     "message": "PONG"
   }

(back to top)

Roadmap

• [Feature or task 1]
• [Feature or task 2]
• [Feature or task 3]
• [Feature or task 4]

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributing

Contributions are welcome and encouraged! Here's how you can contribute:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat(scope): Add some AmazingFeature (fixes #123)')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Don't forget to give the project a star if you find it helpful! 😄

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

[David Ojo] - [@conceptcodes] - [[e-mail]]

Project Link: https://github.com/conceptcodes/zoomies-api

(back to top)