Skip to content

Latest commit

 

History

History
150 lines (106 loc) · 5.86 KB

README.md

File metadata and controls

150 lines (106 loc) · 5.86 KB

License Badge

brand

5 Sherpas

Table of Contents

Project Description

The 5 Sherpas app generate great suggestions on constructive activities based on your goals for personal improvement. At the end of the each week you will be able to see your level of contentment in different aspects of life, such as wellness, career, and relationships among others.

Application Concept

It's all about Wellness

Did you know that each interrelated wellness dimension (emotional, spiritual, environmental, physical, social, and intellectual) is important in the pursuit of optimum health, according to the World Health Organization.

The 5 Sherpas app helps you to achieve a healthier and more balanced life by suggesting activities called weekly challenges. After creating your account and login you will be able to select your initial three categories from the list below:

  • Wellness
  • Intelligence
  • Well-roundedness
  • Organization
  • Career
  • Bad Habit Cessation
  • Interpersonal Relationships

The dashboard will then display the three challenges that the Sherpas chose for you from your previously selected categories. Each new challenge has three optional action buttons:

  • Done: To check off a challenge as being completed
  • Never: To never see a suggested challenge again
  • Swap: To ask the Sherpas for a new suggestion in that category

You will see your progress for every week reflected in the Sherpa-chart and the global number of your completed challenges displayed in the Total Progress badge.

Yakan Do It!

You can always consult the Sherpas on the dashboard to get new suggestions on mental activities, physical activities, and even to get a movie suggestion! The Sherpas' friendly Yak will be encouraging you in your personal journey to achieve the very best version of yourself! Give it a try and feel Yak-tastic!

Try 5 Sherpas now!

User Story

As a person who struggles with various aspects of wellness, I want a guide to help me take constructive steps to improve my life So I can realize my goals and the qualities I want my life to reflect.

Installation

The 5 Sherpas app is hosted on heroku, no special installation is required other than a web browser for mobile or desktop devices. (Google Chrome is recommended).

Features

  • Instantly updating graph
  • User login and logout
  • Password and email validation (frontend and backend)
  • Protected/authenticated routes
  • Will account for users that don’t long in for a long period of time
  • Securely storing passwords in the backend
  • Allowing the user to change password
  • Disable user info fields unless editing
  • List of user challenges updates with user profile changes
  • Users can choose to never see a given challenge again or just swap for a new one
  • User gets new challenges every week
  • Shows unique navigation for logged in users
  • Fully responsive
  • We have an encouraging yak

Application Preview

iPad

iPhone

iPad

5 Sherpas App Slideshow.

Technology and Framework

  • Mongoose
  • MongoDB Atlas
  • Semantic UI React Components
  • D3 for data visualization
  • PassportJS and bcryptJS
  • ReactJS (Create React App)
  • Node/Express Web server
  • Heroku
  • MVC Paradigm
  • Prettier, EsLint and pre-commit hooks (using Husky & Lint-staged)

Contributing

  • This project was created by Caleb, Dan, Luke, Jon, and Josh
  • This app is licensed under the MIT licensing model. Feel free to fork the repo or clone it locally to your machine and make whatever changes you'd like.

Questions

  • Feel free to send a DM to any of the original contributors to this repo.

Future Features

  • Modal popup for more context and ideas for challenges
  • User keyword selection to refine profile
  • Expanding all categories in the DB
  • A helpful "Yak" that also acts as a setup guide
  • Add a storytelling about the app on the landing page
  • Choosing the user avatar

License

MIT License Copyright (c) 2020 MVC-5

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.