ultrastudent / fund_project

In this academic project, we have developed a robust API service that facilitates the collection of funds for various charitable projects. Leveraging the power and speed of FastAPI, our platform provides a seamless and efficient way for users to contribute to worthy causes.

Charity Fund

Description

Charity Fund - API-service to collect funds on charity projects.

Installation

1. Clone repository:

git clone [e-mail]:MikeWazowskyi/cat_charity_fund.git

cd cat_charity_fund

2. Create .env file using .env_example:

.env_example

• In Docker container + GNU make:

  make start
  

• Linux/macOS

  chmod +x run.sh
  
  ./run.sh
  

• Windows OS

  run.bat
  

Examples of API requets:

Charity project's endpoints

POST /charity_project/

Request:

Content-Type: application/json

{
  "name": "New project",
  "description": "New project description",
  "full_amount": 10000 
}

Response:

{
  "name": "New project",
  "description": "New project description",
  "full_amount": 10000,
  "id": 1,
  "invested_amount": 0,
  "fully_invested": false,
  "create_date": "2023-08-24T14:15:22Z",
  "close_date": "2023-08-24T14:15:22Z"
}

GET /charity_project/

Content-Type: application/json

Response:

[
  {
    "name": "New project",
    "description": "New project description",
    "full_amount": 10000,
    "id": 1,
    "invested_amount": 0,
    "fully_invested": false,
    "create_date": "2023-08-24T14:15:22Z",
    "close_date": "2023-08-24T14:15:22Z"
  }
]

DELETE /charity_project/{project_id}

Content-Type: application/json

Response:

[
  {
    "name": "New project",
    "description": "New project description",
    "full_amount": 10000,
    "id": 1,
    "invested_amount": 0,
    "fully_invested": false,
    "create_date": "2023-08-24T14:15:22Z",
    "close_date": "2023-08-24T14:15:22Z"
  }
]

UPDATE /charity_project/{project_id}

Content-Type: application/json

Request:

Editable fields:

• name
• description
• full_amount

{
  "name": "Updated new project",
  "description": "Updated new project description",
  "full_amount": 10000 0
}

Response:

[
  {
    "name": "Updated new project",
    "description": "Updated new project description",
    "full_amount": 100000,
    "id": 1,
    "invested_amount": 0,
    "fully_invested": false,
    "create_date": "2023-08-24T14:15:22Z",
    "close_date": "2023-08-24T14:15:22Z"
  }
]

Donation's endpoints

POST /charity_project/

Request:

Optional fields:

• comment

Content-Type: application/json

{
  "comment": "New donation",
  "full_amount": 10000 
}

Response:

{
  "full_amount": 10000,
  "comment": "New donation",
  "id": 1,
  "create_date": "2023-08-24T14:15:22Z"
}

GET /donation/

Content-Type: application/json

Response:

[
  {
    "full_amount": 1000,
    "comment": "New donation",
    "id": 1,
    "create_date": "2023-08-24T14:15:22Z",
    "user_id": 1,
    "invested_amount": 0,
    "fully_invested": false,
    "close_date": "2023-08-24T14:15:22Z"
  }
]

GET /donation/my

Content-Type: application/json

Response:

[
  {
    "full_amount": 1000,
    "comment": "New comment",
    "id": 1,
    "create_date": "2023-08-24T14:15:22Z"
  }
]

API documentation address:

http://<host>:<port>/docs

About Author:

https://github.com/MikeWazowskyi