Skip to content

BloomTech-Labs/Encon-fe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Encon - Front End

MIT

EnCon lets users see and track their energy usage. The front end is built with a mobile first approach using React. The app allows us to pick a device and input it's usage in hours and days then it calculates the amount of electricity it uses (in kwh) and the amount of money it will cost. If a user registers a profile they can track multiple devices with handy visualizations (graphs and charts) of the usage.

The Team

Alex Martinez Ben Berger David Yanofsky Michael Ross Trey Hugh
Alex Martinez Ben Berger David Yanofsky Michael Ross trey Hugh
Github Github Github Github Github

Getting Started

After cloning the repo, cd into the encon folder then run npm i to install the dependencies needed. running the command 'npm start' will initiate the app. npm run test will start testing

Dependencies

Axios - handles our HTTP request Bootstrap - provides some components Context - handles application state Node-sass - used for styling React - the main framework used to build the app React-Burger-Menu - provides burger menu React-Calendar - provides calendar widget React-DOM provides DOM specific methods to react React-Hook-Forms - handles all forms from inputs to validation Re-Chart - provides charts Styled-components - used to style app

Other Attributions

Icons made by Nikita Golubev

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.

Documentation

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published