Skip to content

BloomTech-Labs/foster-together-fe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Foster Together

You can find the deployed project at https://app.fostertogether.co/signup.

Contributors

Steve Dole Michelangelo Markus Brendan Schatz Bianca Severino
Full Stack Developer Full Stack Developer Full Stack Developer Full Stack Developer
Jarrod Skahill Marc Dandoy Frantz Audige Stacy Williams
Full Stack Developer UX Designer UX Designer Team Lead
Lihuang Zheng Ricardo Leite Tyler de Friess Lisa Cook
Full Stack Developer Full Stack Developer Full Stack Developer Full Stack Developer
Dan Cashion
Full Stack Developer


MIT React code style: prettier Code Climate coverage

Project Overview

Foster Together is a nonprofit organization that connects foster families to volunteers (or "neighbors") in their area that can help with various tasks like cooking and transportation.

The main problem that the organization faces: data is scattered into multiple emails and spreadsheets, making it difficult to keep track of neighbors and foster family information.

Our goal with this application is to streamline the process for volunteer and family sign up, make it easier for the admins to view and interact with data, and automate the matching process.

From the Foster Together website:

In general, two myths persist about foster parents. Either they're "doing it for the money" (sometimes true, but not the norm) or they're a special, heroic kind of person with time and a big heart to spare. Through a public relations campaign based on real life foster parents, Foster Together will introduce you to "someone like you" who makes foster care work, with the right motivations and support from neighbors.

When tragedy strikes, local communities jump in with tangible relief efforts. Foster care exists as disaster relief in the most tragic of life events for a child. Through Random Acts of Foster Kindness, we connect neighbors with foster parents to meet a simple need like a delicious feast delivered at dinnertime, or transportation for a child's therapy appointments. We make it easy. We make it fast. We make it relational.

Key Features

  • Registration process for families and neighbors
  • Dashboard for admins to view and interact with database
  • Integration with Checkr for background checks

Tech Stack

Front end built using:

Build encapsulated components that manage their own state, then compose them to make complex UIs.

Includes utilities to simplify common use cases like store setup, creating reducers, immutable update logic, and more. Provides good defaults for store setup out of the box, and includes the most commonly used Redux addons built-in.

Utilizing tagged template literals and the power of CSS, styled-components allows you to write actual CSS code to style your components. It also removes the mapping between components and styles.

Formik takes care of the repetitive and annoying stuff--keeping track of values/errors/visited fields, orchestrating validation, and handling submission--so you don't have to. This means you spend less time wiring up state and change handlers and more time focusing on your business logic.

React Router is a collection of navigational components that compose declaratively with your application.

Front end deployed to Amazon Web Services

Back end built using:

As an asynchronous event-driven JavaScript runtime, Node.js is designed to build scalable network applications.

Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.

Knex.js is a "batteries included" SQL query builder for Postgres, MSSQL, MySQL, MariaDB, SQLite3, Oracle, and Amazon Redshift designed to be flexible, portable, and fun to use. It features both traditional node style callbacks as well as a promise interface for cleaner async flow control, a stream interface, full featured query and schema builders, transaction support (with savepoints), connection pooling and standardized responses between different query clients and dialects.

PostgreSQL is a powerful, open source object-relational database system with over 30 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

APIs

Checkr (coming soon)

Checkr is a modern, RESTful API-driven background screening service. The Checkr API uses resource-oriented URLs, supports HTTPS authentication and HTTPS verbs, and leverages JSON in all responses passed back to customers.

MapBox allows for precise location data with a built-in map. This is the API used for the map on the Admins dashboard. To use it, you'll need to create a free account and get a free token. You'll need to change the enviroment variable to the token you get as well as the token in Redux memthunks. https://api.mapbox.com/geocoding/v5/mapbox.places/${values.address}%20${values.city}%20${values.state}.json?country=US&access_token={TOKEN HERE}

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

*  REACT_APP_API_URL - base URL for backend API (should end with /api)
*  REACT_APP_MAPBOX_TOKEN - you need a token from mapbox.com - use default public token here

Testing

  • Jest
  • React Testing Library
  • Supertest

Installation Instructions

  • Clone this repo
  • yarn to install all required dependencies
  • yarn test to start the testing environment

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.

For Deps

About

No description or website provided.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages