This is a RESTful API built using Golang and Gorilla Mux. This application also utilizes Docker for containerization, Postgres as the database.
MIT License
This is a RESTful API built using Golang and Gorilla Mux. This application also utilizes Docker for containerization, Postgres as the database.
This Golang REST API serves as a robust backend solution for [describe its purpose or application domain]. It facilitates [mention key functionalities or services it provides].
Ensure the following dependencies are installed on your system:
go.mod
fileFollow these steps to set up and run the application:
Clone the repository:
git clone https://github.com/pashamakhilkumarreddy/golang-rest-api
Change into the project directory:
cd golang-rest-api
Build the application:
go build
Run the application:
./golang-rest-api
This project includes Docker Compose files for production, and staging environments. Before using Docker, ensure you have the required environment variables set in the corresponding .env files (see .env.example as a reference).
To build and run Docker containers:
Ensure Docker is installed and running on your system.
Build and run Docker postgres image for development or production:
docker run -it -p 5432:5432 -d postgres
Build and run Go API for development or production:
docker-compose up
To effectively use this API, follow these guidelines:
If configuration is necessary for your environment or deployment, here's how you can configure it:
We welcome contributions to enhance the functionality of this API. To contribute, please follow these steps:
git checkout -b feature/your-feature
).git commit -am 'Add some feature'
).git push origin feature/your-feature
).For additional contributing guidelines, see the Contributing guide.
This project is licensed under the [License Name]. See the LICENSE file for details.