Skip to content

Latest commit

 

History

History
185 lines (123 loc) · 28 KB

README.md

File metadata and controls

185 lines (123 loc) · 28 KB
Raw

Refresh

Maintainability Test Coverage

You can find the deployed project at AWS Amplify.

Contributors

Labs18

Dayton Steinmeyer Daniel Wallen Roman Jordan Melissa Murphy Josh Cooter
iconfinder-84-Dev-logo-logos-4373243
Bio Bio Bio Bio Bio
Christina Delligatta Jeremy Brady Gina Christians Michael Baynon Taylor Watson
Bio Bio Bio Bio Bio


Labs21

Justin Brandley Carlos Villalpando Justin Williams Coltyn Wiewel


Labs23

Justin Brandley Brandi Jones Shawn Patel Alexis Villaraza Suffyan Tariq

Project Overview

Trello Board

Product Canvas

UX Design files

Refresh is a healthy habit app designed specifically for Lambda School students and staff. We took a poll of 50+ students and discovered the overwhelming majority feels they don't have time for anything beyond their studies.

Unfortunately, this perspective can easily lead to burn-out and health consequences. Our app exists for the sole purpose of helping every Lambdanite build simple but powerful healthy habits that will transform them into strong, energetic, productive beings.

Key Features

  • Admin login
  • User login
  • Team Based Accounts
  • Points System/Leaderboard
  • User photo avatars
  • User health metrics tracking
  • Daily retro form

Tech Stack

Front end built using:

React

Why React?

  • Easy to scale
  • Many components
  • High performance
  • Fast loading time

Additional libraries/dependencies:

  • Moment
  • LESS
  • Reactstrap
  • React Testing Library
  • Circular Progress Bar
  • React-Redux
  • Redux-Thunk
  • React-Modal
  • React-Popup
  • redux-mock-store
  • redux
  • react router

Front end deployed to AWS Amplify

Back end built using:

NodeJs

Why Node?

  • Consistent syntax
  • Efficient to test
  • High performance

Additional libraries/dependencies:

  • Axios
  • Bcrypt
  • Chalk
  • Cors
  • Cross-Env
  • Crypto
  • Dotenv
  • Ejs
  • Express
  • Helmet
  • Jest
  • JSON Web Token
  • Knex
  • Knex-Cleaner
  • Morgan
  • Node Mailer
  • Nodemon
  • Passport
  • Postgres
  • SQLite
  • Supertest
  • Web-Push

Testing

We utilized React Testing Library coupled with Jest. Also, we integrated GitHub actions for continuous integration with the application. Furthermore, we used Code Climate as an extended mechanism for code reviews and overall quality of code maintenance.

Installation Instructions

Install the dependencies listed above with "npm i" or "yarn add" before running the application. As the app is regularly updated, perhaps check the Package.json to verify you have every dependency you need.

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.