Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pashamakhilkumarreddy/golang-rest-api
This is a RESTful API built using Golang and Gorilla Mux. This application also utilizes Docker for containerization, Postgres as the database.
https://github.com/pashamakhilkumarreddy/golang-rest-api
docker docker-compose github-actions golang mux postgres
Last synced: 30 days ago
JSON representation
This is a RESTful API built using Golang and Gorilla Mux. This application also utilizes Docker for containerization, Postgres as the database.
- Host: GitHub
- URL: https://github.com/pashamakhilkumarreddy/golang-rest-api
- Owner: pashamakhilkumarreddy
- License: mit
- Created: 2021-08-04T18:12:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-14T15:11:12.000Z (5 months ago)
- Last Synced: 2024-09-29T10:24:47.047Z (about 1 month ago)
- Topics: docker, docker-compose, github-actions, golang, mux, postgres
- Language: Go
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Golang REST API
This is a RESTful API built using Golang and Gorilla Mux. This application also utilizes Docker for containerization, Postgres as the database.
## Table of Contents
- [Introduction](#introduction)
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Steps](#steps)
- [Docker](#docker)
- [Usage](#usage)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)
## Introduction
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].
## Installation
### Prerequisites
Ensure the following dependencies are installed on your system:
- Go (version 1.22.X or higher)
- Postgres
- Docker
- Other dependencies are listed in the `go.mod` file
### Steps
Follow these steps to set up and run the application:
1. **Clone the repository:**
```bash
git clone https://github.com/pashamakhilkumarreddy/golang-rest-api
```
2. **Change into the project directory:**
```bash
cd golang-rest-api
```
3. **Build the application:**
```bash
go build
```
4. **Run the application:**
```bash
./golang-rest-api
```
#### Docker
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:
```bash
docker run -it -p 5432:5432 -d postgres
```
- Build and run Go API for development or production:
```bash
docker-compose up
```
## Usage
To effectively use this API, follow these guidelines:
- [Include detailed instructions on how to interact with the API, including endpoints, request formats, and responses. Provide examples of common usage scenarios.]
## Configuration
If configuration is necessary for your environment or deployment, here's how you can configure it:
- [Explain configuration file formats, environment variables, or other configuration mechanisms.]
## Contributing
We welcome contributions to enhance the functionality of this API. To contribute, please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature`).
3. Implement your changes.
4. Test your changes thoroughly.
5. Commit your changes (`git commit -am 'Add some feature'`).
6. Push to the branch (`git push origin feature/your-feature`).
7. Create a new Pull Request.
For additional contributing guidelines, see the [Contributing guide](./CONTRIBUTING.md).
## License
This project is licensed under the [License Name]. See the [LICENSE](LICENSE) file for details.