habits

A simple habit tracker, built on the Cloudflare stack.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

"When you learn to transform your habits, you can transform your life."
-James Clear, Author of Atomic Habits

habits is a habit tracker that's built on the Cloudflare stack. It allows you to easily track your habits and build new ones.

This project was built as part of Cloudflare's Spring Developer Challenge 2022. It is a fully working app.

(back to top)

Built With

• Cloudflare Pages
• Cloudflare Workers
• Cloudflare Workers KV
• lukeed/Worktop
• Next.js

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You will need a Cloudflare account as well as an Auth0 account to run the app. The free versions are sufficient for both of them.

You will also need the Wrangler CLI for the backend and Yarn/Node.js for the frontend.

Installation

1. Clone the repo

   git clone https://github.com/flowirtz/habits.git

2. Follow the instructions in apps/habits-frontend/README.md to install the frontend.
3. Follow the instructions in apps/habits-backend/README.md to install the backend.

(back to top)

Roadmap

• Make the date selector work
• Restrict CORS
• Add authentication to the backend
• Edit habits
• Delete habits
• Add a GitHub-like heatmap to explore trends

See the open issues for a full list of proposed features (and known issues).

(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

Developed and distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Flo Wirtz - @flowirtz

Project Link: https://github.com/flowirtz/habits

(back to top)

Acknowledgments

Thank you to the Cloudflare Developer Challenge for giving me the motiviation to finally build this!

(back to top)