You can find the deployed project at TidyHive.
TidyHive simplifies home management with an easy-to-use interface and a robust feature set allowing you organize everything in your home from day-to-day tasks to larger projects.
| Heather Ridgill | Micah Jank | Katrina Roaix | Yankho Trumble |
|---|---|---|---|
 |
|
|
|
| Zach Taylor | Vinni Hoke | Brandon Dresselle - TL |
|---|---|---|
| |
|
|
- TidyHive gives you the ability to organize and manage your todos in a simple and easy way.
- Manage and share household todos from any device.
- Assign todos to household members
- We are able to use a "virtual browser" that is more friendly than a real browser (Virtual DOM)
- Reusable components
- 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.
- Includes a varity of objects and elements to incorporate into our app.
- React Router is a collection of navigational components that compose declaratively with your application.
Google Sign in
- For easy access
- From user research, most users like to use social media as an easy and fast way to sign in quickly.
Front end deployed using Vercel
Back-end built using:
- As an asynchronous event-driven JavaScript runtime, Node.js is designed to build scalable network applications.
- 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.
- Knex can be built using a JavaScript build tool such as browserify or webpack. In fact, this documentation uses a webpack build which includes knex. View source on this page to see the browser build in-action (the global knex variable).
See Backend Documentation for details on the backend of our project.
- Jest allows us to create mock functions with almost zero configuration and provides a really nice set of matchers that makes assertions easier to read.
- This library encourages your applications to be more accessible and allows you to get your tests closer to using your components the way a user will, which allows your tests to give you more confidence that your application will work when a real user uses it.
- NPM i
- NPM Start
The only env variable you should need for the front end is whatever port the backend is currently listening on.
- i.e if the backend server is listening on port 3000 then your env variable should be REACT_APP_BE_URL=http://localhost:3000
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.