lukas/timetracker
1
0
Fork 0
Code Issues 27 Pull Requests 4 Actions Packages Projects 1 Releases 20 Wiki Activity

Initial version

Lukáš Kucharczyk
2023-01-20 16:27:01 +00:00
commit 2c969e7a81
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Quickstart.md Normal file

@ -0,0 +1,14 @@
## Docker
### docker-compose
The easiest way to set up Timetracker is to use the provided [docker-compose.yml](https://git.kucharczyk.xyz/lukas/timetracker/src/branch/main/docker-compose.yml) file:
```bash
git clone https://git.kucharczyk.xyz/lukas/timetracker.git
cd timetracker
docker-compose up -d
```
Afterwards, the app will be available at `localhost:8000`.
### Container image
It is also possible to use a Docker image of Timetracker directly, either from my container registry at `registry.kucharczyk.xyz/timetracker` or by building the provided Dockerfile.
However in this scenario you need to have a way of serving static files served at the `/static` URL.
For an example of how this can be done, refer to the [docker-compose.yml](https://git.kucharczyk.xyz/lukas/timetracker/src/branch/main/docker-compose.yml) and [Caddyfile](https://git.kucharczyk.xyz/lukas/timetracker/src/branch/main/Caddyfile)