Safe Mothers Safe Babies

You can find the deployed project at:

Staging: staging-fe-labs17-safe
Production: production-fe-labs17-safe

View the project demo

Contributors

Aleksandra Foksman	Annique Nsabimana	Blake Prouty	Chris Delfaus	Christian Ubani

Dennis Mercado	Jade E Lopez	Jonathan Dorety	Alexander Vargas

Contributors

Project Overview

Trello Board

Product Canvas

UX Design files

Safe Mother, Safe Babies is a non-profit organization whose goal is to increase health facility access to pregnant mothers residing in Ugandan Villages. The organization relies on data collection of Mothers and volunteer drivers whose information is stored on a database and accessed for risk evaluation and SMS communication purposes. The app consists of several parts:

• Administrative Dashboard that will display mother and driver data from the database.
• Allow the user to perform CRUD operations on the available data
• Give the user the ability to upload data
• Interact and control the dispatch of drivers to mothers in need

Key Features

• Mother CRUD functions
• Driver CRUD functions
• Administrative user CRUD functions

Tech Stack

Front end built using:

React

We chose these frameworks because:

• Scalability
• Ease of readability for the next team who builds on to this project
• Vast selection of libraries to aid in accomplishing our goal
• React's virtual DOM in ReactJS makes for faster development and better user experience
• Allows us to specify various configurations and build reusable components

Libraries

• axios
• formik
• yup
• react-dom
• react-redux
• react-router-dom
• react-scripts
• redux-persist
• redux-thunk

UI Design Libraries

• grommet
• grommet-icons
• styled-components
• priceline-design-system
• react-inlinesvg

Front end deployed to Heroku

Back end built using:

NodeJS + ExpressJS

• Allows for quick building of scalable network applications
• REST API is predictable, and doesn't expose database architecture to FE
• Clean and organized code using packages/middleware for validation, error handling, etc.

Libraries

• axios
• bcryptjs
• cors
• dotenv
• express
• fuse. js
• helmet
• jsonwebtoken
• knex
• knex-cleaner
• pg
• sqlite3

APIs

API documentation can be found 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- will be the base URL for the specific back-end server that the client will be using.
REACT_APP_MIXPANEL_TOKEN= store MixPanel token here for analytics (required for Mixpanel)
REACT_APP_NODE_ENV=production (required for Mixpanel analytics)
** Mixpanel needs the REACT_APP_NODE_ENV variable set to "production" for it to work. **

Content Licenses

Image Filename	Source / Creator	License
Rain.png	Hea Poh Lin	Creative Commons
Sun.svg	Tomáš Otrubčák	Creative Commons

Installation Instructions

Installation

Step 1: Clone Repo

Step 2: Install node modules

npm install

Step 3: To start app on local host

npm start

_Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

_The page will reload if you make edits. You will also see any lint errors in the console.

Step 4: configure for backend

• https://github.com/Lambda-School-Labs/safe-mothers-be

will be the base URL for the specific back-end server that the client will be using.

**NOTE** - npm start is the same as running expo start

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.