python>> volunteering>> 返回
项目作者： WesGtoX

项目描述 ：
API to manage the inclusion of volunteers and actions.
高级语言： Python
项目地址: git://github.com/WesGtoX/volunteering.git
创建时间： 2020-09-17T04:37:10Z
项目社区：https://github.com/WesGtoX/volunteering
开源协议：MIT License
下载



Volunteering


Volunteering CI


About |
Technology |
Getting Started |
Usage |
License


GitHub top language
GitHub language count
GitHub last commit
GitHub issues
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:

Getting Started

Prerequisites

Install and Run

  1. Clone the repository:
    1. git clone https://github.com/WesGtoX/volunteering.git
  2. Set a SECRET_KEY in .env:
    1. cp .env.sample .env
  3. Run:
    1. make run
  4. Run tests:
    1. 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

License

Distributed under the MIT License. See LICENSE for more information.

Made with ♥ by Wesley Mendes :wave: