This is a basic CRUD API for users. The API is built with the following tools:
- Go: The backend language
- MySQL: The database
- Docker: For containerization and managing the application's environment
- Docker Compose: For defining and running multi-container Docker applications
Before you begin, ensure you have met the following requirements:
- You have installed the latest version of Docker and Docker Compose.
To run this project, follow these steps:
- Copy the
.env.example
file to a new file named.env
:
cp .env.example .env
-
Open the
.env
file and replace the dummy values with your actual values. -
Run the following command to start the Docker Compose services:
docker-compose up
This will start all the services defined in your docker-compose.yml
file. Your application should now be running and accessible at the configured ports.
You can find the Postman collection for this API in the docs/postman
directory. You can import this collection into Postman to test the API endpoints.
I use GitHub issues to track the progress of the API development. You can view the open issues and closed issues to see what has been accomplished and what work remains.