Code Monkey home page Code Monkey logo

temelio-grant's Introduction

Temelio Grant Management System

This project aims to streamline the grant-making workflow for foundations by providing a full-stack application that simplifies the process of managing and communicating with nonprofits. The solution includes a backend built with Python FastAPI and a frontend developed using ReactJS.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Before you begin, ensure you have the following installed:

  • Python 3.8 or higher
  • pip (Python package manager)
  • Node.js and npm (Node package manager)

Installation

  1. Clone the repository
git clone https://github.com/nikhilagarwal204/Temelio-Grant.git
cd Temelio-Grant
  1. Set up the backend (FastAPI)

Navigate to the server directory:

cd server

Install required Python dependencies:

pip install -r requirements.txt

Run the FastAPI server:

uvicorn main:app --reload

The FastAPI server will be available at http://localhost:8000.

  1. Set up the frontend (ReactJS)

Open a new terminal window and navigate to the client directory from the root of the project:

cd client

Install required npm packages:

npm install

Start the React development server:

npm start

The React application will be available at http://localhost:3000.

Features

  • Nonprofit Management: Create and save nonprofit organizations along with their metadata (name, address, and email).
  • Foundation Management: Create and save foundation entities along with their metadata (email).
  • Email Templating and Sending: Send templated emails to a list of nonprofits, automatically populating each email with the respective nonprofit's name and address.
  • Email Log Viewing: View all emails that have been sent to nonprofits from a foundation.

Usage

  1. Navigate to http://localhost:3000 in your web browser.
  2. Use the UI to add nonprofits and foundations by entering their information as prompted.
  3. Add one or more nonprofits' email in comma-seperated format and use the interface to send an email.
  4. View sent emails through the provided interface.

Development Notes

  • The backend uses an in-memory database for simplicity; data will not persist if the server is restarted.
  • Email sending functionality is mocked; actual sending logic would involve integrating with an email service provider like SendGrid etc.

temelio-grant's People

Contributors

nikhilagarwal204 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.