{"id":15095919,"url":"https://github.com/odeassis/goodoor","last_synced_at":"2026-02-17T06:01:39.976Z","repository":{"id":249169993,"uuid":"824735732","full_name":"odeassis/goodoor","owner":"odeassis","description":"A job opportunities API built using Golang. The API uses Go-Gin as a router, PostgreSQL as a database, and GoORM for database communication. It also includes Swagger for documentation and a well-organized package structure. ","archived":false,"fork":false,"pushed_at":"2024-07-18T19:05:20.000Z","size":38,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-09T11:38:52.822Z","etag":null,"topics":["api","gin","go","golang","goorm","rest","sqlite"],"latest_commit_sha":null,"homepage":"https://app.swaggerhub.com/apis-docs/odeassis/goodoor-api","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/odeassis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-07-05T20:17:18.000Z","updated_at":"2024-08-14T19:55:19.000Z","dependencies_parsed_at":"2024-07-19T00:24:24.898Z","dependency_job_id":"6415d3da-85f1-4060-806d-ac922cee15c3","html_url":"https://github.com/odeassis/goodoor","commit_stats":null,"previous_names":["odeassis/goodoor"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/odeassis/goodoor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odeassis%2Fgoodoor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odeassis%2Fgoodoor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odeassis%2Fgoodoor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odeassis%2Fgoodoor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/odeassis","download_url":"https://codeload.github.com/odeassis/goodoor/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/odeassis%2Fgoodoor/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29535934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-17T05:00:25.817Z","status":"ssl_error","status_checked_at":"2026-02-17T04:57:16.126Z","response_time":100,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":["api","gin","go","golang","goorm","rest","sqlite"],"created_at":"2024-09-25T15:43:51.912Z","updated_at":"2026-02-17T06:01:39.942Z","avatar_url":"https://github.com/odeassis.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Goodoor Job Opportunities API\n\nThis project is a modern job opportunities API built using Golang. The API is powered by Go-Gin as a router, GoORM for database communication, PostgreSQL as the database, and Swagger for API documentation and testing. The project follows a modern package structure to keep the codebase organized and maintainable.\n\n---\n\n## Features\n\n- Introduction to Golang and building modern APIs\n- Development environment setup for creating the API\n- Using Go-Gin as a router for route management\n- Implementing PostgreSQL as the database for the API\n- Using GoORM for communication with the database\n- Integrating Swagger for API documentation and testing\n- Creating a modern package structure for organizing the project\n- Implementing a complete job opportunities API with endpoints for searching, creating, editing, and deleting opportunities\n- Implementing automated tests to ensure API quality\n\n## Live Version\n\nYou can check the documentation and perform tests to the API by visiting the live version hosted at [goodoor.api](https://app.swaggerhub.com/apis-docs/odeassis/goodoor-api/1.0.0).\n\n## Installation\n\nTo use this project, you need to follow these steps:\n\n1. Clone the repository: `git clone https://github.com/odeassis/goodoor.git`\n2. Install the dependencies: `go mod download`\n3. Build the application: `go build`\n4. Run the application: `./main`\n\n## Makefile Commands\n\nThe project includes a Makefile to help you manage common tasks more easily. Here's a list of the available commands and a brief description of what they do:\n\n- `make run`: Run the application without generating API documentation.\n- `make build`: Build the application and create an executable file named `goodoor`.\n- `make test`: Run tests for all packages in the project.\n- `make docs`: Generate the API documentation using Swag.\n- `make clean`: Remove the `goodoor` executable and delete the `./docs` directory.\n\nTo use these commands, simply type `make` followed by the desired command in your terminal. For example:\n\n```sh\nmake run\n```\n\n## Docker and Docker Compose\n\nThis project includes a `Dockerfile` and `docker-compose.yml` file for easy containerization and deployment. Here are the most common Docker and Docker Compose commands you may want to use:\n\n- `docker build -t your-image-name .`: Build a Docker image for the project. Replace `your-image-name` with a name for your image.\n- `docker run -p 8080:8080 -e PORT=8080 your-image-name`: Run a container based on the built image. Replace `your-image-name` with the name you used when building the image. You can change the port number if necessary.\n\nIf you want to use Docker Compose, follow these commands:\n\n- `docker compose build`: Build the services defined in the `docker-compose.yml` file.\n- `docker compose up`: Run the services defined in the `docker-compose.yml` file.\n\nTo stop and remove containers, networks, and volumes defined in the `docker-compose.yml` file, run:\n\n```sh\ndocker-compose down\n```\n\nFor more information on Docker and Docker Compose, refer to the official documentation:\n\n- [Docker](https://docs.docker.com/)\n- [Docker Compose](https://docs.docker.com/compose/)\n\n## Used Tools\n\nThis project uses the following tools:\n\n- [Golang](https://golang.org/) for backend development\n- [Go-Gin](https://github.com/gin-gonic/gin) for route management\n- [GoORM](https://gorm.io/) for database communication\n- [PostgreSQL](https://www.PostgreSQL.org/index.html) as the database\n- [Swagger](https://swagger.io/) for API documentation and testing\n\n## Usage\n\nAfter the API is running, you can use the Swagger UI to interact with the endpoints for searching, creating, editing, and deleting job opportunities. The API can be accessed at `http://localhost:$PORT/swagger/index.html`.\n\nDefault $PORT if not provided=8080.\n\n## Contributing\n\nTo contribute to this project, please follow these guidelines:\n\n1. Fork the repository\n2. Create a new branch: `git checkout -b feature/your-feature-name`\n3. Make your changes and commit them using Conventional Commits\n4. Push to the branch: `git push origin feature/your-feature-name`\n5. Submit a pull request\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fodeassis%2Fgoodoor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fodeassis%2Fgoodoor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fodeassis%2Fgoodoor/lists"}