Habit Tracker

For this project, you will build a Django application that you can use to track and reinforce daily habits.

Getting started

You'll need to set up a new Django project. You will need to follow the same steps you have been following to install django with pipenv. Consider installing some or all of the following packages:

• django-environ - for easily configuring a .env file
• django-debug-toolbar - for debugging information in the browser
• django-extensions - for extended functionality like shell_plus
• django-registration-redux - for easily handling new user registration and authentication

Postgres and Heroku

This project requires the use of PostgreSQL as its database, and must be deployed to Heroku. You should set both of those up before you do anything else with your application. See our documentation on deploying a Django app to Heroku for a guide.

NOTE: Use Homebrew to install Postgres. Don't download Postgres from the website to install it! See our instructions for how to install and use Postgres locally.

Project Requirements

• Your project should have registration and login.

• Users should be able to create new habits and track those habits with trackers, or daily records (what you call it is up to you).

• Each habit should have a name and a target or goal. What is this "target"? Each habit should have a daily number of some action you want to do. Some examples:

  • I want to walk 1000 steps daily
  • I want to write 100 lines of code daily
  • I want to talk to 2 new people each day
  • I want to read 200 pages daily
  • I want to sleep 8 hours daily

• Once you have habits, you should be able to make a daily record of your activity on each habit. That record should contain a date and a number for that date.

• A user can only have one record per day per habit. You will need to use the constraints option for models with UniqueConstraint to make the habit records unique by user, habit, and day.

• Optimally, users can edit/update records and add records for previous days.

• The URL for creating and updating a record should be the same and should use the habit primary key, year, month, and day in the URL. For example: habit/1/2021/6/18

  • We want to do this so that we can have a single url that will work for a new record and will also allow changing an existing one.
  • You'll want to look into the get_or_create() method for this.
  • You can put the form for creating and updating on this page or elsewhere, as your user interface dictates.

• On the detail page for a habit, you should be able to see all the records for that habit in an HTML table. Show the user whether they met their goal for that day visually somehow -- maybe via colors. Think about accessibility here -- how would a user that can't see know whether they met their goal each day?

• Make your interface as easy to use as possible. Think about what makes the most sense to enter and review data quickly. Consider using a calendar to show records.

Some stretch goals for this project

Consider this a list of ideas. You're welcome to envision and set your own stretch goals.

• Add a line chart to the detail page for a habit showing your records for the last 30 days.
• On the detail page for a habit, show the best day for that habit, and the average day for that habit.
• Add the ability to have "negative habits." These habits should have a goal you want to get under. For example:
  • I want to watch less than 60 minutes of TV daily
  • I want to eat less than 15 jellybeans a day
  • I want to say less than 3 curse words a day
• If a user is missing a record for a habit for the previous day, show them a message on their dashboard that lets them know and asks them to put in the record. Make it easy to jump from that message to the form to enter the data.
• When you list the records for a habit, show any days that don't have a record that are between the first and last record. For example, if there's a record for June 28 and a record for June 30, show June 29 as well and highlight that it has missing data. Provide a way to fill in that data easily.
• Add a public dashboard for each user with data about their habits and recent statistics.

How much of this is JavaScript?

You can make your forms a lot more usable by adding JavaScript. To begin with, you can have a button for making a record that then shows a form without reloading the page.

If you want to add charts to your habits, you'll definitely need JavaScript. Check out Chart.js.

Rubric

Completion

1. (Unsatisfactory) Does not allow for habit and record creation, does not automatically assign habits to users (via request.user) and records to habits (via URL), or does not show record history in date order.
2. (Satisfactory) Allows for creation of habits and records with automatic assignment to parent models. Shows history of records in date order (forwards or backwards). Prevents multiple records for the same habit per day. Allows for update and deletion of records.
3. (Exemplary) Some stretch features added.

Design

1. (Unsatisfactory) Is not styled.
2. (Satisfactory) Has CSS (provided by custom stylesheet, library, or framework) to make the site usable.
3. (Exemplary) Care taken with design features to make the site easy to use and/or accessible. Has sensible defaults throughout the application.

Django usage

1. (Unsatisfactory) Does not store data via models, does not use forms, or does not use GET and POST for views correctly.
2. (Satisfactory) Has User, Habit, and Record models (or equivalent), uses forms for all data entry, standard use of views and URLs.
3. (Exemplary) Writes custom functionality in views, uses Django queries to get aggregated values.