FairShare

Contributors

Adalberto May	Estevan Rodriguez	Itel Domingo	Tsai Huang	Joseph Golden

Overview

FairShare keeps track of everyone’s contributions. Now, you’ll add more than just shop tracking, but full shared-living tracking. New features allow you to create a task list and then keep track of who did what and who is assigned what.

You can find the project at https://goofy-sinoussi-c017bd.netlify.com

Key Features

* Login with OAuth
* Create, edit & delete task
* Update and edit task
* Create, edit & delete comments
* Display task on board filtered by complete and incomplete
* Repeat task for cycle of one to three hours
* Add a group
* Invite member to a group
* Mobile Responsiveness

Frameworks and Libraries

Front end built using:

• React
• Moment.Js
• MDBreact

Back end built using:

• Node.Js
• Express.Js
• PostgreSQL

APIs

Authentication API here

Replace text below with a description of the API

Installation

1. Install Node.js on your machine.
2. To begin, clone both the Frontend and Backend repositories from https://github.com/labs12-chores-1 and download them on your local machine.
3. In the Backend, run yarn to install the needed dependencies.
4. after the installation, run yarn server from the root of the directory to start the backend server on http://localhost:9000.
5. In the Frontend, cd into the labs12-chores-1-FE directory and run yarn.
6. While still in the labs12-chores-1 directory, run yarn start.
7. Navigate to http://localhost:3000 to view the locally deployed site.

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. In front-end, create an .env file in the root of the directory containing the following:

NODE_ENV='development'
REACT_APP_AUTH0_CLIENT_ID='C6Ya6pdhQB68H5MBcOVMuWuuU5MetwHu'
REACT_APP_AUTH0_DOMAIN='dev-zbckx2jg.auth0.com'

Additionally, in the root of the Backend directory, create a .env file with the text below:

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.

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.

1. Remember this project is licensed under the MIT license, and by submitting a pull request, your changes should follow the guideline.
2. Update the README.md with details of your code.
3. Submit a pull request with your changes after carefully reviewing and testing your code.

Backend documentation can be found here: Backend