JayShukla8/pomdoro_app

A productivity Application

Productivity Application

Table of Contents

1. Project Description
2. Key Features
3. Project Structure
4. Application Installation
5. Usage
6. Continuous Integration: CircleCI Badge
7. Code Coverage: CodeCov Badge
8. Project Author
9. License

Project Description:

A dynamic web application that allows users The Productivity Application is designed to help users stay focused and organized by combining two essential tools: a music-enhanced Pomodoro timer and a personal journal. The Pomodoro timer allows users to manage their work and break intervals using the Pomodoro technique, while listening to lofi or chill music to create a calming work environment. The application also includes a journal feature where users can write, format, and track their thoughts or tasks, making it a holistic tool for improving focus and productivity.

Key Features:

• Pomodoro Timer: A focus timer that helps users divide their work into intervals, with customizable focus and break times.
• Music Integration: Plays a selection of background music during focus sessions to enhance concentration.
• Journal: Allows users to create, format, and save journal entries, helping them document tasks, ideas, or reflections.
• Dark and Light Modes: Includes a switch between dark and light themes for a personalized user experience.

Project Structure

The project is organized into the following directories:

• pomodoro/: Contains Django project settings and configurations.
• bulletin/: The Django app for the bulletin boards.
• journal/: The Django app for the journal.
• focus_timer/: The Django app for the pomodoro timer.
• static/: Houses static files such as CSS, music, and images.

Application Installation

To run this project on your local system, follow these steps:

1. Clone the repository from GitHub:

   https://github.com/nokuthabam/pomdoro_app.git
   

2. Installing Django and creating a virtual environment:

   • mkvirtualenv my_django
   • workon my_django
   • pip install django

3. Install project dependencies:

   • pip install -r requirements.txt

4. Navigate to the project directory:

   • cd pomdoro_app

5. Apply database migrations:

   • python manage.py migrate

6. Create a superuser to manage the Django admin panel:

   • python manage.py createsuperuser

7. Start the development server:

   • python manage.py runserver

8. Access the website at http://127.0.0.1:8000/

Usage

- Visit http://127.0.0.1:8000/ to access the login page

• Click register to create your account and access the journal, bulletin board and focus timer.

Continuous Integration: CircleCI Badge

Code Coverage: CodeCov Badge

Project Author

Nokuthaba Moyo

License

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