Table of Contents
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.
- User Registration and Authentication
- Pet Management
- Appointment Scheduling
- Groomer Availability Management (if applicable)
- Checkout Wiki for more details
Before you begin, ensure you have met the following requirements:
- PostgreSQL (Recommended version: 13+)
- Golang (Recommended version: 1.16+)
To get this API up and running, follow these steps:
-
Clone the repo:
git clone https://github.com/conceptcodes/zoomies-api-go.git
-
Navigate to the project directory:
cd zoomies-api-go
-
Install dependencies:
go get .
-
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
- Create a
-
Run DB Migration:
go run ./migrations
-
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 =========== =====================================================
-
Make a request to our health check endpoint:
curl http://localhost:8000/api/health/alive
you should see the following response:
{ "message": "PONG" }
- [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.
Contributions are welcome and encouraged! Here's how you can contribute:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'feat(scope): Add some AmazingFeature (fixes #123)'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Don't forget to give the project a star if you find it helpful! 😄
Distributed under the MIT License. See LICENSE.txt
for more information.
[David Ojo] - [@conceptcodes] - [conceptcodes@gmail.com]
Project Link: https://github.com/conceptcodes/zoomies-api