Skip to content

ThomasJasonM1/charity-tracker

Repository files navigation

Charity Tracker

Description

This application allows a user to save charities to a database and add/update contact information and best ways to help. The app was specifically designed with businesses in mind, ideally with one employee or department (the "Admin") contacting charities with which the company would like to partner and establishing a working relationship. The app would then allow all company employees to view the list of partnered charities, and decide from there if they would like to donate, volunteer, etc.

Future instances of the app would provide a calender of events through which employees could sign up to attend, buy a table, or volunteer. There would also be a method to donate directly to any charity from the app, with contributions being automatically matched if the company donation matches with that specific organization.

User Story As a company dedicated to partnering with charities I want an app that allows me to search for and save charities into a database So that my employees can more readily find, connect with, and contribute to charities

Table of Contents

  1. Creators
  2. Technologies
  3. Usage
  4. License
  5. Contributing
  6. Questions

Creators

Thomas Jason

  • Database creation and management
  • HTML and API routes
  • Node/Express setup

Nick Wuerz

  • User authentication
  • Admin profile functionality
  • Product layout and design

Valerie Earl

  • Search display
  • Non-admin user views/display
  • Final presentation

Thomas Davis

  • Database creation and management
  • Frontend/Backend connection
  • HTML and API routes
  • Graphics

Kayla Gordon

  • API handling
  • Database connection
  • Organization page display/functionality

Technologies

  • React
  • Charity Navigator API
  • Node.js
  • Express.js
  • MongoDB/Mongoose
  • bcrypt
  • Framer Motion
  • Material-UI
  • React Bootstrap

Usage

https://charity-wowness.herokuapp.com/

Login Info

  • Username: test
  • Password: test

Navigate to the site above. Charity organizations already saved in the database will appear on the main page. Click on the "View" link to see further details of any specific charity. Using the login information above, a user can gain full access to the site, along with the ability to edit their profile information and search for and add new charities to the database. The admin can also add/edit point of contact information, whether or not the company matches donations and partners with the organization for volunteering, and the best ways to help.

To Install

npm i

To Run

npm start

Adding Admin to Database

To add an admin user to the database, make a post request to https://charity-wowness.herokuapp.com/api/user/

{
	"firstName": <FIRST NAME>,
	"lastName": <LAST NAME>,
	"email": <EMAIL>,
	"phone": <PHONE #>,
	"image": <IMAGE URL>,
	"username": <USERNAME>,
	"password": <PASSWORD>
}

License

licenseBadge


Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributing

If you would like to contribute to this project you can:

Questions

If you have questions about this application, please reach out to the creators via the email on their respective GitHub profiles, provided above.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published