Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 7f5717e

Browse files
Updating the README.md file
1 parent 8b89a93 commit 7f5717e

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

‎README.md‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
1-
# JavaSpringBoot-ReactJS-TailwindCSS
1+
# Grant Management System for Nonprofits
2+
3+
## Overview
4+
This project aims to simplify the grant-making workflow for foundations and nonprofits, enhancing the effectiveness of the nonprofit community.
5+
6+
## Problem
7+
Large foundations often face the challenge of sending formal emails to numerous nonprofits they support, containing specific details like the nonprofit's name, address, and the current date. Manually creating these emails can be time-consuming and error-prone. Our goal is to develop a full-stack application to automate and manage this workflow efficiently.
8+
9+
## Features
10+
- Create and save nonprofits with their metadata (name, address, email)
11+
- Create and save foundations with their metadata (email)
12+
- Send templated emails to nonprofits with personalized fields
13+
- View a history of emails sent to nonprofits
14+
15+
## Assumptions
16+
- Email serves as a unique identifier for both nonprofits and foundations
17+
- Valid data is assumed for API requests
18+
19+
## Technologies Used
20+
- Backend: Java 17 with Spring Boot
21+
- Frontend: ReactJS with TailwindCSS
22+
23+
## Deployment
24+
The project has been deployed and can be accessed at [Grant Management System](https://ngo-admin.demo.mayankagrawal.co.in/foundations)
25+
26+
## Mock Email Sending
27+
The backend uses a mock email client to simulate sending emails when API requests are made.
28+
29+
## Instructions
30+
1. Clone the repository
31+
2. Set up the backend using Java 17 and Spring Boot
32+
3. Set up the frontend using ReactJS with TailwindCSS
33+
4. Access the deployed application using the provided link
34+
35+
## Contributing
36+
This project is open to contributions from anyone interested in enhancing the grant-making process for nonprofits. Your contributions can help make a positive impact on the nonprofit community.
37+
38+
## Feedback and Questions
39+
If you have any feedback, questions, or suggestions, feel free to reach out.
40+
connect me at `jobs@mayankagrawal.co.in` or can DM me on [LinkedIn](https://www.linkedin.com/in/mayank-agrawal-59192940/).

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /