This commit is contained in:
Andriy Frolov 2025-05-12 21:06:10 +02:00
parent 4ce88a9d5f
commit 9b65235154

View File

@ -53,7 +53,7 @@ The **Karel Robot Simulator** is a static, browser-based educational tool that l
## 4. How to View & Use ## 4. How to View & Use
### On Netlify ### On Netlify
```bash ``bash
export NETLIFY_AUTH_TOKEN="" export NETLIFY_AUTH_TOKEN=""
netlify login # needed once to login to your netlify netlify login # needed once to login to your netlify
netlify link # will use the token instead of prompting you netlify link # will use the token instead of prompting you
@ -67,7 +67,7 @@ netlify deploy --prod --dir=.
### Locally via Docker ### Locally via Docker
1. **Build** the Docker image: 1. **Build** the Docker image:
```bash ``bash
./prepare-app.sh ./prepare-app.sh
Start the container(s): Start the container(s):
./start-app.sh ./start-app.sh
@ -77,6 +77,8 @@ Stop when finished:
Cleanup image & containers: Cleanup image & containers:
./remove-app.sh ./remove-app.sh
---
## 5. Maintenance-Mode Scripts ## 5. Maintenance-Mode Scripts
enable-maintenance.sh enable-maintenance.sh
@ -88,6 +90,8 @@ Restores the live simulator (index.html/manual.html) as the root content.
You can run these anytime via the Netlify CLI, provided you have your NETLIFY_SITE_ID and NETLIFY_AUTH_TOKEN in your environment. You can run these anytime via the Netlify CLI, provided you have your NETLIFY_SITE_ID and NETLIFY_AUTH_TOKEN in your environment.
---
## 6. Execution Conditions ## 6. Execution Conditions
Docker Tools (Engine, BuildKit or legacy builder, and Compose plugin) installed. Docker Tools (Engine, BuildKit or legacy builder, and Compose plugin) installed.
@ -95,10 +99,12 @@ Netlify CLI authenticated (netlify login) if you run the maintenance scripts or
Scripts should be run from the project root containing the Dockerfile and HTML files. Scripts should be run from the project root containing the Dockerfile and HTML files.
---
## External References ## External References
Karel Format: https://karel.sourceforge.net/doc/html_mono/karel.html -Karel Format: https://karel.sourceforge.net/doc/html_mono/karel.html
Netlify Docs: https://docs.netlify.com/ -Netlify Docs: https://docs.netlify.com/
Docker & Nginx: https://docs.docker.com/, https://nginx.org/ -Docker & Nginx: https://docs.docker.com/, https://nginx.org/