alexgustafsson / timekeep Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 0.0 2.72 MB

A simple and private timetracker with data you own. Built with Vue 3 and Typescript

Home Page: https://timekeep.axgn.se

License: MIT License

JavaScript 62.66% Vue 15.21% CSS 20.19% HTML 1.28% Dockerfile 0.34% Shell 0.30%

vue single-page-app progressive-web-app timekeep time-management time-tracker

timekeep's Introduction

Timekeep

A simple timekeeping web app using modern techniques such as modern EcmaScript, Poi (Webpack, Babel etc.) and Vue. Try it live: https://timekeep.axgn.se.

The UI is heavily inspired by the great work of uixNinja over at https://dribbble.com/shots/8659108-Dashboard-user-interface.

Quickstart

# Clone the repository
git clone https://github.com/AlexGustafsson/timekeep

# Enter the directory
cd timekeep

## Option A:
# Install dependencies
npm install
# Option A 1: Run development server
npm run dev
# Option A 2: Build and run minimal server
npm run build
npm run start

## Option B:
# Build and run using Docker
./docker-build.sh
docker run -it -p 3000:3000 axgn/timekeep

# You can now go to http://localhost:3000 or http://localhost:4000 if you're using the development server

Quickstart
Features
Technology
Development
Disclaimer

Features

Stunning dark UI
Intuitive user experience for simple timekeeping
Keeps track of time spent on projects even when the app is closed
Works fully offline with client-side storage
Exports data for use with Excel
296kB gzipped

Technology

Poi

Poi is a zero-config bundler built on the top of webpack. By using the buzz word zero-config, it does not mean that there's no config, instead we pre-configurared many things for you. To prevent Poi from becoming too bloated to use, we also introduced some kind of plugin system to make extra features opt-in.

Visit Poi here.

Vue

Vue (pronounced /vjuː/, like view) is a progressive framework for building user interfaces. It is designed from the ground up to be incrementally adoptable, and can easily scale between a library and a framework depending on different use cases. It consists of an approachable core library that focuses on the view layer only, and an ecosystem of supporting libraries that helps you tackle complexity in large Single-Page Applications.

Visit Vue here.

Development

# Clone the repository
git clone https://github.com/AlexGustafsson/timekeep

# Enter the directory
cd timekeep

# Install dependencies
npm install

# Follow the conventions enforced
npm run lint
npm run stylelint
npm run test
npm run coverage
npm run check-duplicate-code

# Build for production
npm run build

Disclaimer

Although the project is very capable, it is not built with production in mind. Therefore there might be complications when trying to use the project for large-scale projects meant for the public. The project was developed to easily keep track of time spent on things and as such it might not promote best practices nor be performant.

timekeep's People

Contributors

Stargazers

Watchers

timekeep's Issues

Add link to GitHub

Implement tag auto-completion

When a tag is to be added to a project, existing tags by the same or similar names should be shown in order to auto-complete them.

Implement Service Worker to be offline-first

Implement Service Worker in order to support fully offline operation of the site.

Evaluate SQLite migration

https://jlongster.com/future-sql-web

Reimplement Excel export

After the state rewrite, the Excel export needs to be rewritten.

Make menu transparent and blurred

Make the side menu transparent and blurred.

Implement versioning of stored data

Implement versioning of stored data to help aid backwards compatibility / upgradability.

Implement editable times

Could be implemented using a separate number of time to either add or retract, since time is tracked using checkpoints.

Implement context menu

Implement a context menu for the project cards to:

Start / stop the project
Favorite / unfavorite the project
Edit the project
Remove the project

Add groups to the listing

Add groups to the home page listing.

Excel complains about exported files

The exported files can be opened in Excel, but it complains, saying that it was corrupt. If one bypasses the prompt, however, one can view the sheet as intended.

Also see upstream: exceljs/exceljs#739.

Sometimes multiple timekeeps are tracking

For some reason, there is a change that multiple timekeeper are tracking.

Finalize history implementation

The history page should allow users to navigate through the years and see a heat map of days they've worked on projects.

Implement exporting

Implement export of the data:

Raw (as is for backup)
Excel
CSV(?)

Implement tags page

The tags page should allow the user to easily find projects based on tags.

Day scroller not correct during midnight

The week scroller is not correct during the night. At 00:00 the previous day is shown.

Implement insights page

Implement a simple insights page with non-customizable diagrams such as those found here: https://dribbble.com/shots/9532186-Time-Management-Dashboard.

Implement ability to remove projects

Add a button in the edit page for projects to remove the project entirely.

Add option to reset favorites each week

Add option to reset favorites each week.

Implement pretty random colors

Currently the random colors used for the tags etc. are poorly generated in order to not add a dependency. Perhaps, specify a large palette or the like in order to generate pretty random colors. Also use the HSL values or the like in order to decide automatically if there should be white or black text on the tags?

Locale (language and timezone)
Nuke the state (GitHub-like danger zone)