A Nextcloud app to track time spent on work, life or anything in-between.
Looking for screenshots, official release packages or a place to leave a rating? π Visit the app on the Nextcloud Appstore
π± Looking for a mobile companion app? Try the Android app (currently in beta) made by @joleaf.
- π Organize time entries based on tasks, projects and clients.
- π€ Quickly record a time entry for your latest tasks.
- β Check or uncheck a time entry (e.g. to save whether you've billed it).
- π§βπ» Get summaries of your time spent on tasks, projects and clients.
- π Take a glance at simple, but useful statistics.
- π Create basic reports using filters, timerange selection and a simple graph.
- π€ Track your time together with others by sharing a client and its associated projects and tasks (web app only).
- π° Work with start & end of time entry or duration.
- Allow tracking of time in the background.
Work with start & end of time entry or duration.β- Allow to organize time entries without assigning them to tasks, projects or clients.
- REST API improvements for mobile clients
The client-side JavaScript of this plugin uses ES6 features and needs to be transpiled for use in a browser. To run a watch command that automatically updates the bundle.js
file when you make changes, execute npm run dev
. To make a simple build, use npm build
.
Before building or development, dependencies need to be installed once by running npm install
.
Some end-to-end testing is done using Cypress. Tests currently cover basic features of the app and run in a headless Chrome browser on a dockerized Nextcloud instance. For this repository tests run on a mirror repository on Gitlab.
To run tests locally, change into the tests
directory. Before running or working on tests, run npm install
to install dependencies. Make sure to create a .env
file based on .env.example
and a cypress.env.json
based on cypress.env.example.json
; values can be chosen freely, only make sure they align between the two files.
To run the app install docker and docker-compose on your machine. Then run docker-compose up
, followed by docker exec $(docker ps -qf "name=app") sh -c 'chown www-data:root custom_apps'
. Wait for the app to be ready, then run docker exec -u www-data $(docker ps -qf "name=app") sh -c 'php -f ./occ app:disable firstrunwizard'
.
Finally, run npm start
and use Cypress' UI to start running the tests included in the spec file.
To shut down containers and delete the temporary volumes, run docker-compose down -v
in a second terminal while you're in the same tests
directory.
Test cases might depend on running in a specific order. This means you might need to wind down your docker containers and start them again as described above when re-running tests.
New features are supposed to be covered by end-to-end tests in a way that reflects their average usage.
Bugfixes are supposed to include a test case that demonstrates the bug being fixed and prevent it to be re-introduced in the future.
The changelog is available in the CHANGELOG file