Watchme

Watchme is a simple time tracking software with analytics. Everything is hosted on a local server in Docker, and the data is stored locally in MariaDB.

Introduction

This project is far from perfection, but it's a fun project for personal use, designed to help me learn new things and track my various projects. Despite the abundance of software options available, I tried to utilize frameworks and libraries I already knew and some that I wanted to learn.

The main goal is to store data about:

When I worked on which project? How long did I work on each project? What did I do during that time?

Features

Project Management: Easily create and manage your projects.

Time Tracking: Add detailed time entries with comments for each project.

Stopwatch: Use the built-in stopwatch to track your work in real-time. You can add the recorded time directly to a project.

Reminders: Set up two timers to remind you to take breaks – one for drinking and one for standing. Customize the timer durations in the settings.

Analytics: Get insights into your work:

Pie Chart: Visualize the distribution of time spent on each project.

Bar Chart: Track daily work durations. Apply filters for specific projects and time periods.

Detailed Table: View additional information about your work, including the date, duration, and comments.

Easy Deployment: Deploy Watchme with a single command for hassle-free setup.

Bulk Import/Export: Import new projects or time entries via API, and export your data conveniently.

Installation and Getting Started

Requirements:

Ensure you have Docker installed and running on your system.
Download Configuration Files: Obtain the Dockerfile, Docker-compose.yml and init.sql from this repository. Store them in the location where you want to store your project data.
Navigate to the Project Directory: Open your terminal and navigate to the directory where you've placed the configuration files and where you want the data to be stored.
Start the Application: In the terminal, execute the command docker-compose up. This may take some time, but upon completion, a "data" folder will be created to store your database data.
Access the Application: Open your web browser and visit "localhost:8000" to access the Watchme application. From there, you can start tracking your projects.

Prerequisites

You only need Docker to run this project. The project uses several libraries and frameworks like Vue, Laravel, composer, npm, Vite, Axios, Chart.js, chartjs-plugin-zoom, vue-ctk-date-time-picker and vue-timer-hook, but Docker manages these dependencies, so you don't need to install them separately.

Usage

Create a new project by clicking "Add," and a popup will appear.

After creating some projects, choose one from the dropdown and start the stopwatch to track time. You can add comments about what you're doing while working. If you need a break, you can pause and continue later or reset the watch.

Start and stop reminders for drinking and standing. Green indicators show active reminders, and you can hover over them to see the time remaining.

Customize timer durations using the settings in the upper left corner.

Manually add times to specific projects. Choose a project, date, duration, and write a comment about your work.

Switch to the analytics tab to see your projects, time spent, and work details. You can filter by date, date interval, or specific projects. Remove filters by reloading the page or clicking the "x" icon.

-Zoom in on charts by using Shift + mouse scroll or pinching on tablets. You can also hold Shift and mark a specific region to zoom in.

To use the import or export features, you need to download curl or similar software.

Import Projects

curl -X POST -H "Content-Type: application/json" -d @projects.json http://localhost:8000/api/import/projects

Replace @projects.json with your file containing the project data you want to store.

Import Times

curl -X POST -H "Content-Type: application/json" -d @times.json http://localhost:8000/api/import/times

For times, specify the duration in hours in your JSON file.

Feel free to reach out for any questions or support.

DeadMuffin/watchme