Skip to content

Commit 969e9ba

Browse files
committed
attach dockerdocs to readme and index.md file
1 parent 24811e1 commit 969e9ba

3 files changed

Lines changed: 37 additions & 41 deletions

File tree

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -105,20 +105,6 @@ TAURI_SIGNING_PRIVATE_KEY_PASSWORD=pass
105105
npm run tauri build
106106
```
107107

108-
#### Running the Dockerfile
109-
110-
To build the Docker image, use the following command:
111-
```bash
112-
docker build --build-arg TAURI_SIGNING_PRIVATE_KEY=<private_key> --build-arg TAURI_SIGNING_PRIVATE_KEY_PASSWORD=<password> -t <image_name> .
113-
```
114-
Replace <private_key> and <password> with your actual Tauri signing private key and password and <image_name> with the image name. If you are using the default key, you can use the following command:
115-
116-
```bash
117-
docker build --build-arg TAURI_SIGNING_PRIVATE_KEY=dW50cnVzdGVkIGNvbW1lbnQ6IHJzaWduIGVuY3J5cHRlZCBzZWNyZXQga2V5ClJXUlRZMEl5NlF2SjE3cWNXOVlQQ0JBTlNITEpOUVoyQ3ZuNTdOSkwyNE1NN2RmVWQ1a0FBQkFBQUFBQUFBQUFBQUlBQUFBQU9XOGpTSFNRd0Q4SjNSbm5Oc1E0OThIUGx6SS9lWXI3ZjJxN3BESEh1QTRiQXlkR2E5aG1oK1g0Tk5kcmFzc0IvZFZScEpubnptRkxlbDlUR2R1d1Y5OGRSYUVmUGoxNTFBcHpQZ1dSS2lHWklZVHNkV1Byd1VQSnZCdTZFWlVGOUFNVENBRlgweUU9Cg== --build-arg TAURI_SIGNING_PRIVATE_KEY_PASSWORD=pass -t <image_name> .
118-
```
119-
This command uses the preset private key and password.
120-
121-
122108
### Python Backend Setup
123109

124110
#### Installation Steps
@@ -246,6 +232,12 @@ The server will start on `http://localhost:8000` by default. In test mode, the s
246232
247233
You can control the number of workers by setting the `WORKERS` environment variable before running the script. If not set, it defaults to 1 worker.
248234
235+
### Setup using Dockerfile
236+
237+
- For setting up the frontend, follow the instructions in the [Frontend Setup Guide](./docs/frontend/docker-setup.md).
238+
</br>
239+
- For setting up the backend, follow the instructions in the [Backend Setup Guide](./docs/backend/docker-setup.md).
240+
249241
## Additional Resources
250242
251243
- [Tauri Documentation](https://tauri.app/v1/guides/)

docs/frontend/setup.md

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,32 @@ All commands executed below are with respect to the `frontend/` directory
2525
```
2626

2727
2. Install the project dependencies:
28+
2829
- For Windows/Mac
29-
```bash
30-
npm install
31-
```
30+
31+
```bash
32+
npm install
33+
```
34+
3235
- For Linux
33-
36+
3437
1.Installing Dependencies
35-
```bash
36-
npm install
37-
```
38-
2.Grant executable permissions to the setup script:
39-
```bash
40-
chmod +x scripts/setup_env.sh
41-
```
38+
39+
```bash
40+
npm install
41+
```
42+
43+
2.Grant executable permissions to the setup script:
44+
45+
```bash
46+
chmod +x scripts/setup_env.sh
47+
```
48+
4249
3.Run the dependencies script
43-
```bash
44-
npm run setup:linux
50+
51+
```bash
52+
npm run setup:linux
53+
```
4554

4655
For more information on npm commands, see the [npm documentation](https://docs.npmjs.com/).
4756

@@ -94,19 +103,6 @@ This will create an optimized build of your application in the `src-tauri/target
94103

95104
Learn more about building Tauri apps in the [Tauri Building Guide](https://tauri.app/v1/guides/building/).
96105

97-
#### Running the Dockerfile
98-
99-
To build the Docker image, use the following command:
100-
```bash
101-
docker build --build-arg TAURI_SIGNING_PRIVATE_KEY=<private_key> --build-arg TAURI_SIGNING_PRIVATE_KEY_PASSWORD=<password> -t <image_name> .
102-
```
103-
Replace <private_key> and <password> with your actual Tauri signing private key and password and <image_name> with the image name. If you are using the default key, you can use the following command:
104-
105-
```bash
106-
docker build --build-arg TAURI_SIGNING_PRIVATE_KEY=dW50cnVzdGVkIGNvbW1lbnQ6IHJzaWduIGVuY3J5cHRlZCBzZWNyZXQga2V5ClJXUlRZMEl5NlF2SjE3cWNXOVlQQ0JBTlNITEpOUVoyQ3ZuNTdOSkwyNE1NN2RmVWQ1a0FBQkFBQUFBQUFBQUFBQUlBQUFBQU9XOGpTSFNRd0Q4SjNSbm5Oc1E0OThIUGx6SS9lWXI3ZjJxN3BESEh1QTRiQXlkR2E5aG1oK1g0Tk5kcmFzc0IvZFZScEpubnptRkxlbDlUR2R1d1Y5OGRSYUVmUGoxNTFBcHpQZ1dSS2lHWklZVHNkV1Byd1VQSnZCdTZFWlVGOUFNVENBRlgweUU9Cg== --build-arg TAURI_SIGNING_PRIVATE_KEY_PASSWORD=pass -t <image_name> .
107-
```
108-
This command uses the preset private key and password.
109-
110106
## Troubleshooting
111107

112108
If you encounter any issues during setup or running the application:

docs/index.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ This project was announced by [AOSSIE](https://aossie.org/), an umbrella organiz
6666
API
6767
</a>
6868
</li>
69+
<li>
70+
<a href="./backend/docker-setup.md">Docker setup</a>
71+
</li>
6972
</ul>
7073
</div>
7174
<div style="width:25%">
@@ -76,6 +79,11 @@ This project was announced by [AOSSIE](https://aossie.org/), an umbrella organiz
7679
Setup
7780
</a>
7881
</li>
82+
<li>
83+
<a href="./frontend/docker-setup.md">
84+
Docker Setup
85+
</a>
86+
</li>
7987
<li>
8088
<a href="./frontend/ui-components">
8189
UI Components
@@ -93,4 +101,4 @@ This project was announced by [AOSSIE](https://aossie.org/), an umbrella organiz
93101
</li>
94102
</ul>
95103
</div>
96-
</div>
104+
</div>

0 commit comments

Comments
 (0)