Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saurabh9136/donation_platform
Danadiksha is a donation platform where users can connect with NGOs, make donations, and receive transparency through tax relief certificates and video proof of their contributions.
https://github.com/saurabh9136/donation_platform
angular django html javascript python scss typescript
Last synced: 20 days ago
JSON representation
Danadiksha is a donation platform where users can connect with NGOs, make donations, and receive transparency through tax relief certificates and video proof of their contributions.
- Host: GitHub
- URL: https://github.com/saurabh9136/donation_platform
- Owner: saurabh9136
- Created: 2024-10-28T13:09:47.000Z (21 days ago)
- Default Branch: main
- Last Pushed: 2024-10-29T05:22:55.000Z (20 days ago)
- Last Synced: 2024-10-29T06:20:11.387Z (20 days ago)
- Topics: angular, django, html, javascript, python, scss, typescript
- Language: SCSS
- Homepage:
- Size: 9.03 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Danadiksha
Danadiksha is a donation platform where users can connect with NGOs, make donations, and receive transparency through tax relief certificates and video proof of their contributions. It includes JWT-based authentication and utilizes Django Rest Framework (DRF) for the backend and Angular for the frontend.
---
## Notes
- **Frontend Development**: The frontend component is under development. It will include user and NGO portals for donation management, donation tracking, and transparency features.
- **AWS Configuration**: AWS configuration is pending to securely store and manage NGO images, terms and conditions certificates, proof videos, and tax relief certificates.
## Project Flow
1. **User Registration and Login**
- Users and NGOs can independently register on the platform.
- Users receive a confirmation upon successful registration.
- NGOs are registered to manage donation activities and update proofs.
2. **User Donation Process**
- Users select an NGO and choose an amount to donate.
- Upon donation, the platform deducts a platform commission and confirms the donation.
- A tax relief certificate is generated and made available for download.
3. **NGO Proof and Certificate Upload**
- NGOs upload proof of distribution (e.g., video, images) and necessary documentation.
- The platform stores these files (to be configured on AWS).
- Donors are notified once the proof is uploaded.
4. **Admin Management**
- Admins have control over user and NGO accounts.
- They manage homepage banners and control platform content as needed.
5. **User Dashboard and Donation History**
- Users can view their donation history, download receipts, and check NGO updates.
- Real-time updates will be implemented to keep users informed of NGO activities.
## Features
- **User and NGO Registration**: Users and NGOs can register and create accounts independently.
- **JWT Authentication**: Secures API endpoints with JWT-based token authentication.
- **Donation Management**: Users can donate to NGOs, who can then record proof of fund usage and upload tax certificates.
- **Transparency**: NGOs provide video evidence and tax certificates post-donation.
- **Role-Based Access**: Ensures secure access for users and NGOs.
---
## Tech Stack
- **Backend**: Django Rest Framework (DRF)
- **Frontend**: Angular with standalone components
- **Database**: SQLite
---
# Danadiksha API Documentation
## API Endpoints
1. **User Registration** - `POST /api/users/register`
- **Request**:
```json
{
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"password": "password123",
"mobile_number": "1234567890",
"city": "New York",
"address": "1234 Elm Street",
"country_region": "USA"
}
```
- **Response**:
```json
{
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"email": "[email protected]",
"status": "Active"
}
```
2. **NGO Registration** - `POST /api/ngos/register`
- **Request**:
```json
{
"ngo_name": "Animal Welfare",
"email": "[email protected]",
"password": "securepassword",
"registration_number": "12345",
"mobile_number": "1234567890",
"city": "San Francisco",
"address": "5678 Oak Street",
"country_region": "USA"
}
```
- **Response**:
```json
{
"ngo_id": "123e4567-e89b-12d3-a456-426614174000",
"email": "[email protected]",
"status": "Active"
}
```
3. **User Login** - `POST /api/login`
- **Request**:
```json
{
"email": "[email protected]",
"password": "password123"
}
```
- **Response**:
```json
{
"access": "",
"refresh": "",
"user": 1
}
```
4. **Create Donation** - `POST /api/donations/`
- **Request**:
```json
{
"user": "123e4567-e89b-12d3-a456-426614174000",
"ngo": "987e6543-e89b-12d3-a456-426614174111",
"amount": 100,
"message": "For a better cause",
"payment_method": "Credit Card"
}
```
- **Response**:
```json
{
"donation_id": "789e4567-e89b-12d3-a456-426614174333",
"status": "Initialized",
"amount": 100,
"message": "For a better cause"
}
```
5. **Upload Tax Certificate and Video Proof** - `POST /api/donations//upload_proof/`
- **Request**:
- `tax_certificate`: (File)
- `video_proof`: (File)
- **Response**:
```json
{
"status": "Success",
"message": "Tax certificate and video proof uploaded successfully."
}
```