{"id":18594374,"url":"https://github.com/figaarillo/golerplate","last_synced_at":"2026-01-24T03:33:31.799Z","repository":{"id":242443335,"uuid":"809556742","full_name":"Figaarillo/golerplate","owner":"Figaarillo","description":"GOlerplate is a Boilerplate for Go","archived":false,"fork":false,"pushed_at":"2024-08-26T12:34:04.000Z","size":12351,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T22:03:09.568Z","etag":null,"topics":["boilerplate","clean-architecture","docker","go","golang","gorilla-mux","gorm","hexagonal","swagger"],"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/Figaarillo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2024-06-03T02:05:45.000Z","updated_at":"2024-09-01T16:23:44.000Z","dependencies_parsed_at":"2024-06-03T04:11:20.967Z","dependency_job_id":"ec60efe2-3841-4e3d-ab78-a6223c0e0f1b","html_url":"https://github.com/Figaarillo/golerplate","commit_stats":null,"previous_names":["figaarillo/golerplate"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Figaarillo%2Fgolerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Figaarillo%2Fgolerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Figaarillo%2Fgolerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Figaarillo%2Fgolerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Figaarillo","download_url":"https://codeload.github.com/Figaarillo/golerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252522185,"owners_count":21761686,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["boilerplate","clean-architecture","docker","go","golang","gorilla-mux","gorm","hexagonal","swagger"],"created_at":"2024-11-07T01:15:21.549Z","updated_at":"2026-01-24T03:33:26.767Z","avatar_url":"https://github.com/Figaarillo.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"[English](README.md) | [Spanish](./project/README.es.md)\n\n# GOlerplate\n\nGOlerplate is a template for web applications in Golang. This means it can be a starting point for web applications in Golang, designed to facilitate development with a clean and modular architecture.\n\n## Technologies\n\n- **Language**: Go\n- **Frameworks and Libraries**: Gorilla Mux, GORM\n- **Containers**: Docker, Docker Compose\n- **Documentation**: Swagger\n\n## Getting Started\n\n### Prerequisites\n\n- [Docker](https://docs.docker.com/get-docker/)\n- [Docker Compose](https://docs.docker.com/compose/)\n- [Go](https://golang.org/doc/install) (optional if you want to use CLI)\n\n### Clone the repository\n\n1. Clone the repository:\n\n    ```sh\n    git clone https://github.com/Figaarillo/golerplate.git\n    cd golerplate\n    ```\n\n2. Copy the `.env.example` file to `.env`:\n\n    ```sh\n    cp .env.example .env\n    ```\n\n### Usage\n\n- Run the server and database through Docker\n\n    ```sh\n    make docker.run\n    ```\n\n- Run the server locally and the database with Docker\n\n    ```sh\n    make run\n    ```\n\n### How to run tests?\n\n#### Unit Tests\n\nTo run all unit tests:\n\n  ```sh\n  make test.unit\n  ```\n\nTo run a single unit test:\n\n  ```sh\n  make test.unit.[entity_name]\n  ```\n\nFor example, to run the unit test for category:\n\n  ```sh\n  make test.unit.category\n  ```\n\n#### Integration Tests\n\nTo run all integration tests:\n\n  ```sh\n  make test.e2e\n  ```\n\nTo run a single integration test:\n\n  ```sh\n  make test.e2e.[entity_name]\n  ```\n\nFor example, to run the integration test for category:\n\n  ```sh\n  make test.e2e.category\n  ```\n\n## Project Structure\n\n```sh\n.\n├── cmd\n│   └── api                # Main entry point of the application\n├── docs                   # Swagger generated documentation\n├── internal\n│   ├── application\n│   │   └── usecase        # Application use cases\n│   ├── domain\n│   │   ├── entity         # Domain entity definitions\n│   │   ├── exception      # Domain exception handling\n│   │   └── repository     # Repository interfaces\n│   ├── infrastructure\n│   │   ├── handler        # HTTP handlers\n│   │   ├── middleware     # HTTP middlewares\n│   │   ├── repository     # Repository implementations\n│   │   └── router         # Route definitions\n│   ├── setup              # Initial setup\n│   ├── share\n│   │   ├── config         # Shared configuration\n│   │   ├── exception      # Shared exception handling\n│   │   ├── utils          # Shared utilities\n│   │   └── validation     # Shared validations\n│   └── test               # Unit and integration tests\n└── scripts                # Automation scripts\n```\n\n## Features\n\n- REST API: CRUD implementation for entities.\n- Tests: Unit and integration tests.\n- Documentation: API documentation with Swagger.\n- Architecture: Implements clean and hexagonal architecture principles.\n\n\u003c!--## Contributing--\u003e\n\u003c!----\u003e\n\u003c!--If you want to contribute to the project, please follow these steps:--\u003e\n\u003c!----\u003e\n\u003c!--1. Fork the repository.--\u003e\n\u003c!--2. Create a branch (`git checkout -b feature/new-feature`).--\u003e\n\u003c!--3. Make your changes (`git commit -am 'Add new feature'`).--\u003e\n\u003c!--4. Push to the branch (`git push origin feature/new-feature`).--\u003e\n\u003c!--5. Create a new Pull Request.--\u003e\n\nLicense\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffigaarillo%2Fgolerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffigaarillo%2Fgolerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffigaarillo%2Fgolerplate/lists"}