FocusHacker is a web application designed to help users track their tasks and improve their productivity. It includes a Work Diary where all your tagged completed entries will go and which you can explore in more detail to unlock your key time periods of productivity.
This README provides an overview of the project, instructions for getting started, and details on how to use the app effectively.
Individual Entry's
The Productivity App is built using React and Chakra UI. It consists of two main components:
- Timer: The app includes a timer that tracks the time spent on each task.
- Task Entry: Users can enter their tasks and add optional tags to categorize them.
- Pause and Continue: The timer can be paused and continued as needed.
- Completed Entries List: The app keeps track of completed tasks and displays them in a table format.
To run the Productivity App locally, follow these steps:
- Node.js installed on your machine.
- Python3 and Django installed
- Clone the repository:
git clone https://github.com/your-username/productivity-app.git
- Navigate to the project directory:
cd FocusHacker/frontend
- Install the dependencies:
npm install
- Run
npm runserver
For Backend
- Navigate to
cd FocusHacker/backend
- Run ```python3 manage.py runserver` to fetch all your entries from the database
- Start the development server:
npm start
- Open your web browser and visit
http://localhost:3000
to access the app. - In the DialogBox component, enter a task in the input field and add a tag (optional).
- Click the "Start" button to start the timer.
- Once the task is completed, it will appear in the Completed Entries list, which is displayed in the CompletedEntries component.
We welcome contributions to the Productivity App project. If you would like to contribute, please follow these guidelines:
- Fork the repository and create a new branch.
- Make your changes and test them thoroughly.
- Submit a pull request, describing the changes you've made and any additional information.
The Productivity App is open-source software released under the MIT License. You are free to use, modify, and distribute the code in accordance with the terms of the license.
I would like to thank the Chakra UI and React communities for their excellent libraries and resources that have contributed to the development of this project.