saamiya96/_dojo-habit-tracker-client

Welcome to Dojo!

Dojo is the name of our habit tracker, where users can sign up and register an account with us! Users can then login into their account and start tracking their habits. Want to track how many laps you have done this week for swimming? You can! Or do you want to track you running habits in the month of July? You can now with Dojo! You can also track you habits in a pie chart to see how well you are doing!

Table of Contents

• Installation & Usage
  • Installation
  • Local Usage
  • Deployment
• See the Sites
• Technologies
• Changelog
• Wins & Challenges
  • Wins
  • Challenges
• Bugs
• Goals for the Future!

Installation & Usage

Installation

• Clone or download the repo
• Navigate to the dojo_habit_tracker_server folder at the command line
• Run npm install to install dependencies

Local Usage

• Enable docker to run on your computer
• Navigate through the scripts folder, starting with teardown.sh then startDev.sh
• Navigate through the commands for each script file and run the server locally

Deployment

• View the client live on Netlify

Testing

• While in the api folder, git branch to test, run npm test to launch the test suite

See the Sites

Sign up to Dojo...

...and start tracking your own habits!

Technologies used

Planning & Design Tools

• Trello Board (View our template here)
• Figma (View our template here)

HTML/CSS/JS Tools

• Watchify

Changelog

JavaScript

• Controllers
  • auth.js
  • habits.js
  • users.js
• Models
  • habits.js
  • user.js
• Routes
  • habits.js
  • users.js

Wins & Challenges

Wins

• Fully responsive app
• Calendar view enables users to track their progress
• Add notes to each calendar day
• Testing at 62% coverage
• Colourful style to our app

Challenges

• Reaching test coverage over 60%
• Deploying to Heroku

Bugs

• auth.js and user.js are unable to be deployed to heroku, ongoing issue

Goals for the Future!

• Add more functionality to our metrics page e.g. period on period tracking
• Missed a day adding notes to a habit, day fills in red
• Checking boxes on click
• Social components
  • ability to view streaks
• Reward systems for those who complete a week streak

---

Minimum Viable Product

Prework

• write this README
• design using Fignma
• fill Trello board

Functionality

• login page
• register page
• can view notes of habits
• store habits in users account
• track habits

Technical

• 60% test coverage (minimum)
• deploys on netlify

Technologies

• express
• cors
• jest -DEV
• supertest -DEV
• nodemon -DEV
• jest-fetch-mock -DEV

Fun extras

• Favicon!

Contributors to README file

• Saamiya, Thilak & Vincent