Thrivetracker has not yet been deployed
Trello Board
Welcome to ThriveTracker, a new way to help you in your addiction recovery. ThriveTracker is a full-stack application built with React and Django featuring time tracking and progress monitoring functionalities to aid individuals in their addiction recovery journey.
- Create a time tracker for your addiction recovery.
- Track your progress and earn tokens every 30 days (in development).
- Add notes to your time tracker to help you stay on track (in development).
- Calculate your savings from not using your addiction (in development).
The following technologies were used in the development of ThriveTracker:
- React, a JavaScript library for building user interfaces.
- React Router DOM, a routing library for React applications.
- Tailwind CSS, a popular CSS framework for building responsive UIs.
- Axios, a promise-based HTTP client for the browser and Node.js.
- Django, a high-level Python web framework for building robust and scalable web applications.
- Django REST framework, a powerful and flexible toolkit for building Web APIs.
- Django CORS Headers, a middleware that enables Cross-Origin Resource Sharing (CORS) in Django applications, allowing the frontend and backend to communicate with each other.
- Django Rest Framework Simple JWT, an extension for Django REST framework that provides JSON Web Token (JWT) authentication.
To get started with ThriveTracker, follow these steps:
Frontend
- Fork and clone this repository in your CLI.
- Navigate to the directory you just cloned.
- Run npm install to install necessary components.
- Run npm start to run the app in localhost.
Backend
- Navigate to the directory where the backend code is located, thrivetracker_django.
- Install the required dependencies by running pip install -r requirements.txt in your CLI.
- Configure the Django settings in the settings.py file, including setting the SECRET_KEY, DEBUG, and ALLOWED_HOSTS variables.
- Run the Django development server by running python manage.py runserver in your command line. The backend API will now be accessible at http://localhost:8000/ by default.
ThriveTracker is an ongoing project, and there are more features planned for the future, such as:
- Adding the ability to add notes to the time tracker to help users stay on track.
- Calculating and displaying the savings from not using the addiction to motivate users.
- Implementing reminders and notifications to help users stay accountable.
- Adding more customization options for time trackers, such as setting goals and milestones.
Contributions to the ThriveTracker backend are welcome! If you would like to contribute, please follow these guidelines:
- Fork the repository and create a new branch for your feature or bug fix.
- Make your changes and test thoroughly.
- Create a pull request with a detailed description of your changes.
- Ensure that your code follows the project's coding standards and is well-documented.
- Your contribution will be reviewed by the project maintainers, and any feedback will be provided for necessary changes.