Skip to content

sjkchang/Cloze

Repository files navigation

vigilant-waffle

Cloze, a productivity webapp Build Status

How to Run

To run the project, run the run.py file with python 2.7, the go to http://localhost:5000 (pip Install any imports that you do not already have on your system) If you try to run on python 3 you will get an error cannont convert byte to json, install simplejson to fix this.

Test Cases

The test cases are located in vigilant-waffle/cloze, the two files are called test_mealLog and test_dbControl. test_mealLog has 5 tests, and test_dbControl has 3. To run, navigate to project root directory and run the command pytest

Documentation

The sphinx documentation is located in vigilant-waffle/build/html/index.html

Heroku Deployment

https://cloze-cs131.herokuapp.com/ The app deploys succesfully, but when run here, we get an internal server error due to a template not found error and haven't been able to fix it

Feature #1 Register

Registers user into the database, with their username, email, and password To verify: Click on register link on nav bar and register.

Feature #2 Login

Logs registered users into the website using their email and password To verify: When registering, you are automatically logged in. To verify that the login forms work to log in, press logout in the nav bar, then login with the email, and password you used when registering

Feature #3 Logout

To verify: You already verified it works verifying the last feature

Feature #4 Style

To Verify: Look at website, and see that it is styled

Feature #5 Pomodoro Timer

To Verify: Click pomodoro Timer in nav bar. There are four buttons, work should start a 25 minute countdown, shortBreak should start a 5 minute coundown, long break a 15 minute countdown, stop should stop any of the previous countdowns and reset the timer to 25min

Feature #6 Change Username or Email

To verify: Go to account on the nav bar, and fill out the form for what you want to change. Log out and log back in with the new username or email

Feature #7 Add meal

To verify: go to meal log on nav bar, and press the add meal link. Fill out the form, and submit. A banner indicating a meal has been added should be show up, and the information you submited should appear in a content box.

Feature #8 Journal

To verify: after logged in navigate to the journal link, and click on the add entry link. On the new page fill out the form and submit. You should be redirected to the journal page where your entry will be displayed.

Feature #9 TO-DO List

TO verify: After logging in, click on the to do link on the nav bar. Click add entry, fill out the form and submit. You should see your new task appear

Feature #10 Challenges

To verify: After logging in, click on the challenges link on the nav bar. Click add challenge, fill out the form and submit. You should see your challenge, and any other challenge created by any other user on the challenge page.

Feature #11 Edit challenges, meals and journal entries

To verify: Click the edit button on a challenges, meal or journal entry, and resubmit the form with the edited content

Feature #12 Delete challenges, meals and journal entries

TO verify: Click the delete button on a challenges, meal or journal entry, it should disappear

About

Cloze a productivity manager web app

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •