nzambello/work-timer
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: update readme

Browse source
This commit is contained in:
Nicola Zambello 2023-06-22 15:09:02 +02:00
parent ba5628f3c8
commit 4d146f84ad
Signed by: nzambello
GPG key ID: 56E4A92C2C1E50BA
1 changed files with 32 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -1,6 +1,6 @@
# WorkTimer # WorkTimer
<img src="./public/logo.png" width="100" height="100" alt="WorkTimer" /> <img src="https://github.com/nzambello/work-timer/raw/main/public/logo.png" width="100" height="100" alt="WorkTimer" />
Time tracking app built with Remix, supports authentication, projects management, and monthly or custom reports. Time tracking app built with Remix, supports authentication, projects management, and monthly or custom reports.
@ -15,6 +15,7 @@ Built for self-hosting: host it anywhere you want, and use it for free. Your tim
- [Tech stack](#tech-stack) - [Tech stack](#tech-stack)
- [Running locally](#running-locally) - [Running locally](#running-locally)
- [Running with Docker](#running-with-docker) - [Running with Docker](#running-with-docker)
- [Multi-platform docker image](#multi-platform-docker-image)
- [Screenshots](#screenshots) - [Screenshots](#screenshots)
- [License](#license) - [License](#license)
@ -45,6 +46,22 @@ If you want to use different defaults, you can build your own image. See [Runnin
### Docker compose ### Docker compose
Basic example:
```yaml
version: '3.8'
services:
work-timer:
image: nzambello/work-timer
container_name: work-timer
restart: always
ports:
- 8080:8080
volumes:
- ./dockerData/work-timer:/data # Path to data for DB persistence
```
Example of docker-compose.yml with [Traefik](https://traefik.io/) as reverse proxy: Example of docker-compose.yml with [Traefik](https://traefik.io/) as reverse proxy:
```yaml ```yaml
@ -112,28 +129,35 @@ docker built -t work-timer .
docker run -p 127.0.0.1:8080:8080 work-timer docker run -p 127.0.0.1:8080:8080 work-timer
``` ```
### Multi-platform Docker image
```bash
docker buildx create --name mybuilder --driver docker-container --bootstrap --use # create a new builder and switch to it using a single command.
docker buildx build --platform linux/amd64,linux/arm64 -t nzambello/work-timer:latest --push .
```
## Screenshots ## Screenshots
### Light / Dark mode ### Light / Dark mode
<img width="300" src="./public/images/00-time-entries-light.png" /> <img width="300" src="https://github.com/nzambello/work-timer/raw/main/public/images/00-time-entries-light.png" />
<img width="300" src="./public/images/01-time-entries-dark.png" /> <img width="300" src="https://github.com/nzambello/work-timer/raw/main/public/images/01-time-entries-dark.png" />
### Time tracking ### Time tracking
<img width="500" src="./public/images/02-new-time-entry.png" /> <img width="500" src="https://github.com/nzambello/work-timer/raw/main/public/images/02-new-time-entry.png" />
### Projects ### Projects
<img width="300" src="./public/images/03-projects.png" /> <img width="300" src="https://github.com/nzambello/work-timer/raw/main/public/images/03-projects.png" />
<img width="300" src="./public/images/04-new-project.png" /> <img width="300" src="https://github.com/nzambello/work-timer/raw/main/public/images/04-new-project.png" />
### Reports ### Reports
<img width="500" src="./public/images/05-reports.png" /> <img width="500" src="https://github.com/nzambello/work-timer/raw/main/public/images/05-reports.png" />
## License ## License
[Nicola Zambello](https://github.com/nzambello) © 2023 [Nicola Zambello](https://github.com/nzambello) © 2023
[GNU GPLv3](./LICENSE) [GNU GPLv3](https://github.com/nzambello/work-timer/raw/main/LICENSE)