Compare commits

..

1 Commits

Author SHA1 Message Date
1eabad7a0a docs: add a guide for running
Some checks failed
conventional pull request title check / conventional pull request title check (pull_request) Successful in 5s
GitLeaks check / GitLeaks check (pull_request) Successful in 12s
actionlint check / actionlint check (pull_request) Successful in 19s
conventional commit messages check / conventional commit messages check (pull_request) Successful in 17s
dotenv-linter check / dotenv-linter check (pull_request) Successful in 16s
hadolint check / hadolint check (pull_request) Successful in 16s
htmlhint check / htmlhint check (pull_request) Successful in 28s
ShellCheck check / ShellCheck check (pull_request) Successful in 30s
markdownlint check / markdownlint check (pull_request) Failing after 38s
Stylelint check / Stylelint check (pull_request) Successful in 30s
Prettier check / Prettier check (pull_request) Successful in 36s
yamllint check / yamllint check (pull_request) Successful in 36s
checkov check / checkov check (pull_request) Successful in 1m45s
Rust check / Rust check (pull_request) Successful in 13m16s
2026-03-05 14:40:23 +01:00

View File

@@ -9,37 +9,50 @@ A task management app tailored specifically to my personal GTD workflow.
1. Copy `.env.dev` to `.env` and, if desired, edit it.
2. Create a symlink from `docker-compose.yaml` to `docker-compose-dev.yaml`.
3. Run the Docker compose stack with
```
docker compose up --build -d
```
```
docker compose up --build -d
```
4. Enter the container shell with
```
docker compose exec -it app sh
```
```
docker compose exec -it app sh
```
5. Inside, start the development server with
```
dx serve --locked --addr 0.0.0.0 --port 8000
```
6. Once the build is finished, the web app will be accessible at http://localhost:8000.
```
dx serve --locked --addr 0.0.0.0 --port 8000
```
6. Once the build is finished, the web app will be accessible at
http://localhost:8000.
### Production
1. Copy `.env.dev` to `.env` and, if desired, edit it.
2. Create a symlink from `docker-compose.yaml` to `docker-compose-prod.yaml`.
3. Run the Docker compose stack with
```
docker compose up --build -d
```
4. Once the build is finished, the web app will be accessible at the Docker container, port 80.
```
docker compose up --build -d
```
4. Once the build is finished, the web app will be accessible at the Docker
container, on port 80.
## Running the Android client
1. Copy `.env.dev` to `.env` and, if desired, edit it. Set the `MOBILE_SERVER_URL` to the URL of the
server which will be available as a backend for the mobile client.
1. Copy `.env.dev` to `.env` and, if desired, edit it. Set the
`MOBILE_SERVER_URL` to the URL of the server which will be available as a
backend for the mobile client.
2. Start the build with
```
./scripts/export_android_bundle.sh
```
```
./scripts/export_android_bundle.sh
```
3. Once it is finished, the APK will be present at `bundle/android`.
4. Run the web server as described in [Running the web server](#Running the web server) and make it
accessible from the client running the mobile app at the URL specified in the environment variable.
4. Run the web server as described in a previous section and make it accessible
from the client running the mobile app at the URL specified in the environment variable.