JasonxWarren / LVL-UP

a goals tracker utilizing Python and Django, with added in rewards from sponsors.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

LVL-UP

a goals tracker utilizing Python and Django, with added in rewards from sponsors.

User Stories

  1. As a user I want to sign up for an account.

  2. As a user I want to be able to login to an account if I have one.

  3. As a user I want to be able to create a name for my goal.

  4. As a user I want to provide a description for my goal.

  5. As a user I want to be able to update my progress via the dailyz update.

  6. As a user when creating my goal, I want to be able to pick from an assortment of sponsors.

  7. As a user I want to see my reward progress via the dailyz, in order to get a reward from my sponsor.

  8. As a user I’d like to pick multiple sponsors for my goals.

  9. As a user I’d like to be able to ‘redeem’ my reward, and add it to my profile/goals page.

Rudimental wireframes found here- https://www.figma.com/file/Zwep8oAUZfe9tAowXQr9Nf/LVL-UP?node-id=2%3A166

The landing page:

landingpage

The Goal page:

create_goal

The Profile page:

user_profile_page

The ERD:

lvl-up-erd


LVL-UP

README for how to use LVL-UP!

Table of Contents
  1. About LVL-UP
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Screen Shot 2022-04-27 at 7 08 49 PM

LVL-UP was made, as a tool to help people improve their lives. We all have goals, and many of the times these goals consist of us taking on recurring tasks to improve ourselves. Such as working out, eating healthy, sleeping well, practicing a new hobby or sport or skill. LVL-UP gives users the ability to create goals, pick sponsors for their goals, and track their progress over a duration of time, this one is set to 30 days.

As after 30 days we hope that the new habit has stuck. Also users can provide descriptions to their goals to remind themselves what exactly they were to do, and the sponsors are the added bonus. A nice incentive for hitting those daily goals over a period of time, where sponsors may offer up a deal or discount to reward their favorite customers on improving themselves. As self care, and treating one self becomes something that everyone would like to promote in the world, merchants may appreciate, that their product is a reward for their clients hardwork.

I wanted to create a product I could see myself using, and who doesn't want to have tools that help them reach their goals.

(back to top)

Built With

(back to top)

Getting Started

As a new user, you need to sign up and create an account, by providing a username and password, there is error handling so don't try to use password as your password, but even if you do, it'll let you know you can't. signup

Prerequisites

You will need to have python installed as well as.. Postgres. Django. as well as installing pipenv shell

(back to top)

Usage

(back to top)

Roadmap

The first goal has been completed, having a functional MVP to showcase the idea. Future developments include, having a QR code associated with the redeemed the sponsors, that only shows once redeemed. including a public facing user profile to share with friends and family.

Adding a sponsor site, where sponsors can decide how many daily checkins are required for their sponsorship, along with other tooling for their sponsorships.

Many more ideas to come!

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

(back to top)

Acknowledgments

(back to top)

About

a goals tracker utilizing Python and Django, with added in rewards from sponsors.

License:MIT License


Languages

Language:JavaScript 57.7%Language:CSS 39.6%Language:Python 1.7%Language:HTML 1.0%Language:Procfile 0.0%