Skip to content

Latest commit

 

History

History
110 lines (69 loc) · 2.74 KB

README.md

File metadata and controls

110 lines (69 loc) · 2.74 KB

Timewell App

Welcome to Timewell! ⏱️ Timewell is an intuitive time management tool that helps you allocate time effectively and stay focused by working on one task at a time by allocating your time. It’s perfect for anyone looking to improve productivity, reduce distractions, and optimize their workflow.

Features

  • Task Management: Add tasks, allocate time for each, and start working on them.
  • Dark Mode: Easily toggle between light and dark modes for a comfortable viewing experience.
  • Task Status & Priority: Organize tasks by their status (e.g., in progress, completed) and priority.
  • Timer: A built-in timer to track time spent on each task.
  • Pause Tasks: Pause tasks and resume them later, even the next day.
  • Time & Productivity Analysis: Track your time and analyze productivity for better time management.
  • Currently in Beta: Timewell is in its early stages and is open to feedback and improvements.

Tech Stack

  • Frontend: React.js, CSS Modules
  • State Management: React Context API
  • Routing: React Router
  • Deployment: Vercel

Installation

Prerequisites

Ensure you have the following installed:

  • Node.js (v14 or above)
  • npm or yarn

Steps to Install Locally

  1. Clone the repository to your local machine:

    git clone https://github.com/kelixirr/Timewell-App.git

  2. Navigate to the project directory:

    cd Timewell-App

  3. Install the dependencies:

    npm install
# or
yarn install

  4. Run the development server:

    npm start
# or
yarn start

    The app should now be running on http://localhost:3000.

Contributing

We welcome contributions! If you'd like to contribute to Timewell, here’s how you can get started:

  1. Fork this repository.
  2. Create a new branch (git checkout -b feature-name).
  3. Make your changes and commit them (git commit -m 'Add feature').
  4. Push to your forked repository (git push origin feature-name).
  5. Open a pull request.

Issues & Bugs

If you encounter any issues or have suggestions for improvements, feel free to open an issue on the GitHub Issues page.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Thanks to the open-source community for providing tools and resources that made this project possible.

Connect with Us

Feel free to reach out to the maintainers with any questions or suggestions:

That's it! Happy time tracking with Timewell! ⏳