{"id":15161775,"url":"https://github.com/pashamakhilkumarreddy/golang-rest-api","last_synced_at":"2026-02-25T22:04:34.197Z","repository":{"id":114635246,"uuid":"392787134","full_name":"pashamakhilkumarreddy/golang-rest-api","owner":"pashamakhilkumarreddy","description":"This is a RESTful API built using Golang and Gorilla Mux. This application also utilizes Docker for containerization, Postgres as the database.","archived":false,"fork":false,"pushed_at":"2024-06-14T15:11:12.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-02T09:34:18.100Z","etag":null,"topics":["docker","docker-compose","github-actions","golang","mux","postgres"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pashamakhilkumarreddy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-04T18:12:45.000Z","updated_at":"2024-06-14T15:11:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"6bdd6fdf-68d9-4d18-943d-e06e7fdc1fb8","html_url":"https://github.com/pashamakhilkumarreddy/golang-rest-api","commit_stats":{"total_commits":8,"total_committers":2,"mean_commits":4.0,"dds":0.125,"last_synced_commit":"d89ec6a7ab6b6a522311efa84aa4b324a7449ed6"},"previous_names":["pashamakhilkumarreddy/golang-rest-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pashamakhilkumarreddy/golang-rest-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashamakhilkumarreddy%2Fgolang-rest-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashamakhilkumarreddy%2Fgolang-rest-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashamakhilkumarreddy%2Fgolang-rest-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashamakhilkumarreddy%2Fgolang-rest-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pashamakhilkumarreddy","download_url":"https://codeload.github.com/pashamakhilkumarreddy/golang-rest-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashamakhilkumarreddy%2Fgolang-rest-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29842894,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-25T21:18:31.832Z","status":"ssl_error","status_checked_at":"2026-02-25T21:18:29.265Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","github-actions","golang","mux","postgres"],"created_at":"2024-09-27T00:44:56.658Z","updated_at":"2026-02-25T22:04:34.180Z","avatar_url":"https://github.com/pashamakhilkumarreddy.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Golang REST API\n\nThis is a RESTful API built using Golang and Gorilla Mux. This application also utilizes Docker for containerization, Postgres as the database.\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Installation](#installation)\n  - [Prerequisites](#prerequisites)\n  - [Steps](#steps)\n    - [Docker](#docker)\n- [Usage](#usage)\n- [Configuration](#configuration)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Introduction\n\nThis 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]. \n\n## Installation\n\n### Prerequisites\n\nEnsure the following dependencies are installed on your system:\n\n- Go (version 1.22.X or higher)\n- Postgres\n- Docker\n- Other dependencies are listed in the `go.mod` file\n\n### Steps\n\nFollow these steps to set up and run the application:\n\n1. **Clone the repository:**\n\n    ```bash\n    git clone https://github.com/pashamakhilkumarreddy/golang-rest-api\n    ```\n\n2. **Change into the project directory:**\n\n    ```bash\n    cd golang-rest-api\n    ```\n\n3. **Build the application:**\n\n    ```bash\n    go build\n    ```\n\n4. **Run the application:**\n\n    ```bash\n    ./golang-rest-api\n    ```\n\n#### Docker\n\nThis 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).\n\nTo build and run Docker containers:\n\n- Ensure Docker is installed and running on your system.\n\n- Build and run Docker postgres image for development or production:\n\n    ```bash\n    docker run -it -p 5432:5432 -d postgres\n    ```\n\n- Build and run Go API for development or production:\n\n    ```bash\n    docker-compose up\n    ```\n\n## Usage\n\nTo effectively use this API, follow these guidelines:\n\n- [Include detailed instructions on how to interact with the API, including endpoints, request formats, and responses. Provide examples of common usage scenarios.]\n\n## Configuration\n\nIf configuration is necessary for your environment or deployment, here's how you can configure it:\n\n- [Explain configuration file formats, environment variables, or other configuration mechanisms.]\n\n## Contributing\n\nWe welcome contributions to enhance the functionality of this API. To contribute, please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature/your-feature`).\n3. Implement your changes.\n4. Test your changes thoroughly.\n5. Commit your changes (`git commit -am 'Add some feature'`).\n6. Push to the branch (`git push origin feature/your-feature`).\n7. Create a new Pull Request.\n\nFor additional contributing guidelines, see the [Contributing guide](./CONTRIBUTING.md).\n\n\n## License\n\nThis project is licensed under the [License Name]. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpashamakhilkumarreddy%2Fgolang-rest-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpashamakhilkumarreddy%2Fgolang-rest-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpashamakhilkumarreddy%2Fgolang-rest-api/lists"}