docs: add a guide for running
Some checks failed
actionlint check / actionlint check (pull_request) Successful in 7s
hadolint check / hadolint check (pull_request) Successful in 6s
conventional commit messages check / conventional commit messages check (pull_request) Successful in 15s
conventional pull request title check / conventional pull request title check (pull_request) Successful in 17s
dotenv-linter check / dotenv-linter check (pull_request) Successful in 25s
GitLeaks check / GitLeaks check (pull_request) Successful in 26s
Prettier check / Prettier check (pull_request) Failing after 25s
htmlhint check / htmlhint check (pull_request) Successful in 36s
markdownlint check / markdownlint check (pull_request) Failing after 34s
Stylelint check / Stylelint check (pull_request) Successful in 28s
yamllint check / yamllint check (pull_request) Successful in 35s
ShellCheck check / ShellCheck check (pull_request) Successful in 41s
checkov check / checkov check (pull_request) Successful in 1m24s
Rust check / Rust check (pull_request) Successful in 26m25s
Some checks failed
actionlint check / actionlint check (pull_request) Successful in 7s
hadolint check / hadolint check (pull_request) Successful in 6s
conventional commit messages check / conventional commit messages check (pull_request) Successful in 15s
conventional pull request title check / conventional pull request title check (pull_request) Successful in 17s
dotenv-linter check / dotenv-linter check (pull_request) Successful in 25s
GitLeaks check / GitLeaks check (pull_request) Successful in 26s
Prettier check / Prettier check (pull_request) Failing after 25s
htmlhint check / htmlhint check (pull_request) Successful in 36s
markdownlint check / markdownlint check (pull_request) Failing after 34s
Stylelint check / Stylelint check (pull_request) Successful in 28s
yamllint check / yamllint check (pull_request) Successful in 35s
ShellCheck check / ShellCheck check (pull_request) Successful in 41s
checkov check / checkov check (pull_request) Successful in 1m24s
Rust check / Rust check (pull_request) Successful in 26m25s
This commit is contained in:
3
.env.dev
3
.env.dev
@@ -1,2 +1,5 @@
|
||||
# en-US or cs-CZ.
|
||||
LANGUAGE_CODE=en-US
|
||||
|
||||
# Required only for mobile native client builds.
|
||||
MOBILE_SERVER_URL=
|
||||
|
||||
45
readme.md
Normal file
45
readme.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# Todo Baggins
|
||||
|
||||
A task management app tailored specifically to my personal GTD workflow.
|
||||
|
||||
## Running the web server
|
||||
|
||||
### Development
|
||||
|
||||
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
|
||||
```
|
||||
4. Enter the container shell with
|
||||
```
|
||||
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.
|
||||
|
||||
### 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.
|
||||
|
||||
## 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.
|
||||
2. Start the build with
|
||||
```
|
||||
./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.
|
||||
0
scripts/export_android_bundle.sh
Normal file → Executable file
0
scripts/export_android_bundle.sh
Normal file → Executable file
Reference in New Issue
Block a user