You can find the deployed project at beabravone.com.
| Andy Bettisworth | Angel Torres | Brennon Nuckols | Michael Falahee | Rogelio Caballero |
|---|---|---|---|---|
 |
|
|
|
|
Our world is plagued with conflict and devastating violence everywhere you look: bullying in schools, violence in our homes, on the streets, across borders, everywhere. Brāv trains anyone in conflict management who in turn manages the conflicts of others directly on the site.
- On-boarding for new users will include sign-in, sign-up, and logout.
- User settings. A user will be able to change their password, and deactivate their account.
- Creating cases. A user will be able to create a case based on it's type and relation to court systems.
- Manage Cases. A user will be able to add details to a case.
- Search Mediators. A user will be able to filter mediators.
- Selecting Mediators. A user will be able to select a mediator and a Sendgrid E-mail will be sent telling the Mediator.
- Request to be Mediator. The onboarding for mediators will involve a manual approval process.
- Taking payment. A user will be able to pay for mediation services when they have connected with a mediator
- Receiving payment. A Mediator will be able to connect their bank account with Stripe, and will be able to recieve payment when a bill or invoice is paid.
- Uploading documents. A user will be able to upload documents related to a case.
- Downloading documents. A user and Mediator will be able to download documents that were uploaded about the case.
We are using the React library to render the interface and Redux for state management. React is lightweight and unopinionated, so it's perfect for building an MVP.
- Axios: Promise based HTTP client for the browser and node.js used to send requests to our express backend
- Firebase: Helper used to initalize our firebase authentication system
- Firebaseui: Provides simple, customizable UI bindings on top of Firebase SDK to display login and signup forms
- FontAwesome: Allows us to use sleek icons on our application
- History: Easily manages session history anywhere JavaScript runs
- Material-Ui: Implement Google's Material Design, allows us to style components with built in styles
- Mixpanel-Browser: Helper used to work with our analytics tracking
- Moment: Lightweight JavaScript date library for parsing, validating, manipulating, and formatting dates, used to format timestamps
- Node-sass: Allows you to natively compile .scss files to css at incredible speed and automatically via a connect middleware
- React: a JavaScript library for creating user interfaces, used to create the boiler-plate for our application
- React-dom:
- React-loader-spinner: Serves as the entry point to the DOM and server renderers for React
- React-redux: Advanced state management system for React
- React-router-dom: Collection of navigational components that compose declaratively with the application
- React-scripts: Configures boiler-plated scripts for react applications
- React-test-renderer: Provides an experimental React renderer that can be used to render React components to pure JavaScript
- Redux: Redux is a predictable state container for JavaScript applications
- Redux-logger: Logs information in the console about redux actions and reducers
- Redux-thunk: Allows us to write action creators that return a function instead of an action
- Uuid: Simple, fast generation of RFC4122 UUIDS.
Back end deployed to Heroku
We are using a PostgresSQL database deployed on Heroku. To access the database we are implementing a RESTful API using NodeJS, Express, and knex. Node lets you write JavaScript on both the front-end and back-end, which increases readability and reduced context-switching.
Authentication API - Firebase
This API is used to authenticate the individuals, mediators and admin to log into the system using their email and password. It handles identity related tasks.
Payment API - Stripe
This API is connected to payments between users and mediators. It acts as a secure payment solution with multiple payment options. It will allow users to pay mediators for their time and services securely, and easily. We used Chekout with connect to be able to take payments and route them directly to the Mediator
Email API - SendGrid
SendGrid allows us to send secure emails. For example when a user forgets their password and needs to reset or when they need to receive email reminders or notifications.
Analytics API - Mixpanel
This API enables insights into users behavior. User behavior can be broken down into discrete actions and recorded using Mixpanel. The user analytics will help inform feature development.
Intergration Testing API - Cypress
This API enables end to end intergration testing. A fake web browser is set up, and Cypress runs the tests live while showing you what happens every step of the way. It can also take screen shots and recordings when unexpected behavior is found.
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 - the Backend URL.
* REACT_APP_URL - the url used to dynamically pass in callbacks, and redirects
* REACT_APP_STRIPE_KEY - the key used to configure stripe. Can be found in stripe dashboard.
🚫For all content - images, icons, etc, use this table to document permission of use. Remove the two placeholders and add you content to this table
| Image Filename | Source / Creator | License |
|---|---|---|
| doodles.png | Nicole Bennett | Creative Commons |
| rings.svg | Sam Herbert | MIT |
We are using the @testing-library/react dependency for Frontend tests.
We are also using Cypress IO for intergration testing.
Run the following commands to install all dependencies:
npm install
* build - creates a build of the application.
* start - starts the production server after a build is created.
* test - runs tests.
* cypress - runs cypress intergration tests
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.
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.
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.
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.
- 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.
These contribution guidelines have been adapted from this good-Contributing.md-template.
See Backend Documentation for details on the backend of our project.