{"id":20114227,"url":"https://github.com/wesgtox/volunteering","last_synced_at":"2026-04-29T08:34:33.761Z","repository":{"id":108380567,"uuid":"296220316","full_name":"WesGtoX/volunteering","owner":"WesGtoX","description":"API to manage the inclusion of volunteers and actions.","archived":false,"fork":false,"pushed_at":"2020-12-22T23:01:34.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-06T16:45:45.134Z","etag":null,"topics":["api","django","django-rest-framework","docker","docker-compose","pytest","pytest-django","python"],"latest_commit_sha":null,"homepage":"","language":"Python","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/WesGtoX.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":"2020-09-17T04:37:10.000Z","updated_at":"2021-05-04T14:04:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"433d7ee8-eb97-4e64-8a69-904d3e1b3b93","html_url":"https://github.com/WesGtoX/volunteering","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/WesGtoX/volunteering","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WesGtoX%2Fvolunteering","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WesGtoX%2Fvolunteering/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WesGtoX%2Fvolunteering/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WesGtoX%2Fvolunteering/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WesGtoX","download_url":"https://codeload.github.com/WesGtoX/volunteering/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WesGtoX%2Fvolunteering/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32417952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T06:29:02.080Z","status":"ssl_error","status_checked_at":"2026-04-29T06:29:00.631Z","response_time":110,"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","django","django-rest-framework","docker","docker-compose","pytest","pytest-django","python"],"created_at":"2024-11-13T18:28:48.966Z","updated_at":"2026-04-29T08:34:33.744Z","avatar_url":"https://github.com/WesGtoX.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  Volunteering\n  \u003cbr /\u003e\n  \u003cimg alt=\"Volunteering CI\" src=\"https://github.com/WesGtoX/volunteering/workflows/Volunteering%20CI/badge.svg\" /\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#about-the-project\"\u003eAbout\u003c/a\u003e\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#technology\"\u003eTechnology\u003c/a\u003e\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u0026nbsp;\u0026nbsp;|\u0026nbsp;\u0026nbsp;\n  \u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"GitHub top language\" src=\"https://img.shields.io/github/languages/top/wesgtox/volunteering?style=plastic\" /\u003e\n  \u003cimg alt=\"GitHub language count\" src=\"https://img.shields.io/github/languages/count/wesgtox/volunteering?style=plastic\" /\u003e\n  \u003cimg alt=\"GitHub last commit\" src=\"https://img.shields.io/github/last-commit/wesgtox/volunteering?style=plastic\" /\u003e\n  \u003cimg alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/wesgtox/volunteering?style=plastic\" /\u003e\n  \u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/wesgtox/volunteering?style=plastic\" /\u003e\n\u003c/p\u003e\n\n\n# Volunteering\n\nVolunteers is an API to manage the inclusion of volunteers and actions being possible to carry out the entire process of insertion, listing, viewing details, updating and removal.\n\n\n## Technology \n\nThis project was developed with the following technologies:\n\n- [Python](https://www.python.org/)\n- [Django Framework](https://www.djangoproject.com/)\n- [Django REST Framework](https://www.django-rest-framework.org/)\n- [Docker](https://www.docker.com/)\n- [Docker Compose](https://docs.docker.com/compose/)\n\n\n## Getting Started\n\n### Prerequisites\n\n- [Python](https://www.python.org/)\n- [Docker](https://www.docker.com/)\n- [Docker Compose](https://docs.docker.com/compose/)\n\n\n### Install and Run\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/WesGtoX/volunteering.git\n```\n2. Set a `SECRET_KEY` in `.env`:\n```bash\ncp .env.sample .env\n```\n3. Run:\n```bash\nmake run\n```\n4. Run tests:\n```bash\nmake test\n```\n\n\n## Usage\n\n### Endpoints\n\n#### Volunteers\n\n|  Method  | Endpoint          | Description                               |\n| :------: | ----------------- | ----------------------------------------- |\n|  `POST`  | `/volunteers/`    | Register a volunteer.                     |\n|  `GET`   | `/volunteers/`    | List all registered volunteers.           |\n|  `GET`   | `/volunteers/:id` | Show the detail of a specific volunteer.  |\n|  `PUT`   | `/volunteers/:id` | Change the data for a specific volunteer. |\n| `DELETE` | `/volunteers/:id` | Remove a specific volunteer.              |\n\n#### Actions\n\n|  Method  | Endpoint       | Description                            |\n| :------: | -------------- | -------------------------------------- |\n|  `POST`  | `/actions/`    | Create an action.                      |\n|  `GET`   | `/actions/`    | List all created actions.              |\n|  `GET`   | `/actions/:id` | Show the detail of a specific action.  |\n|  `PUT`   | `/actions/:id` | Change the data for a specific action. |\n| `DELETE` | `/actions/:id` | Remove a specific action.              |\n\n_For more examples, please refer to the [**Documentation**](https://github.com/WesGtoX/volunteering/wiki)_\n\n\n## License\n\nDistributed under the MIT License. See [LICENSE](LICENSE) for more information.\n\n---\n\nMade with ♥ by [Wesley Mendes](https://wesleymendes.com.br/) :wave:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwesgtox%2Fvolunteering","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwesgtox%2Fvolunteering","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwesgtox%2Fvolunteering/lists"}