https://github.com/wesgtox/volunteering
API to manage the inclusion of volunteers and actions.
https://github.com/wesgtox/volunteering
api django django-rest-framework docker docker-compose pytest pytest-django python
Last synced: 3 months ago
JSON representation
API to manage the inclusion of volunteers and actions.
- Host: GitHub
- URL: https://github.com/wesgtox/volunteering
- Owner: WesGtoX
- License: mit
- Created: 2020-09-17T04:37:10.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-22T23:01:34.000Z (almost 5 years ago)
- Last Synced: 2025-01-13T06:09:34.263Z (10 months ago)
- Topics: api, django, django-rest-framework, docker, docker-compose, pytest, pytest-django, python
- Language: Python
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Volunteering
About |
Technology |
Getting Started |
Usage |
License
# Volunteering
Volunteers 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.
## Technology
This project was developed with the following technologies:
- [Python](https://www.python.org/)
- [Django Framework](https://www.djangoproject.com/)
- [Django REST Framework](https://www.django-rest-framework.org/)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
## Getting Started
### Prerequisites
- [Python](https://www.python.org/)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
### Install and Run
1. Clone the repository:
```bash
git clone https://github.com/WesGtoX/volunteering.git
```
2. Set a `SECRET_KEY` in `.env`:
```bash
cp .env.sample .env
```
3. Run:
```bash
make run
```
4. Run tests:
```bash
make test
```
## Usage
### Endpoints
#### Volunteers
| Method | Endpoint | Description |
| :------: | ----------------- | ----------------------------------------- |
| `POST` | `/volunteers/` | Register a volunteer. |
| `GET` | `/volunteers/` | List all registered volunteers. |
| `GET` | `/volunteers/:id` | Show the detail of a specific volunteer. |
| `PUT` | `/volunteers/:id` | Change the data for a specific volunteer. |
| `DELETE` | `/volunteers/:id` | Remove a specific volunteer. |
#### Actions
| Method | Endpoint | Description |
| :------: | -------------- | -------------------------------------- |
| `POST` | `/actions/` | Create an action. |
| `GET` | `/actions/` | List all created actions. |
| `GET` | `/actions/:id` | Show the detail of a specific action. |
| `PUT` | `/actions/:id` | Change the data for a specific action. |
| `DELETE` | `/actions/:id` | Remove a specific action. |
_For more examples, please refer to the [**Documentation**](https://github.com/WesGtoX/volunteering/wiki)_
## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
---
Made with ♥ by [Wesley Mendes](https://wesleymendes.com.br/) :wave: