Skip to content

Commit 9161838

Browse files
authored
Merge pull request #133 from indcoder/main
docs: 📝 Update setup instructions for starting the application o…
2 parents 17f70de + 7f57ab8 commit 9161838

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

content/1-hour/0-setup.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,24 @@ With the repository created, it's now time to clone the repository locally. We'l
4646
cd <REPO_NAME_HERE>
4747
```
4848

49-
5. Start the application by running the following command:
49+
5. Start the application by running the script appropriate for your operating system:
5050

51-
```sh
52-
./scripts/start-app.sh
51+
- macOS / Linux:
52+
53+
```sh
54+
./scripts/start-app.sh
55+
```
56+
57+
- Windows (PowerShell):
58+
59+
```powershell
60+
./scripts/start-app.ps1
61+
```
62+
63+
If you encounter execution policy warnings on Windows, run PowerShell as an administrator or execute the script with an explicit bypass, for example:
64+
65+
```powershell
66+
powershell -ExecutionPolicy Bypass -File .\scripts\start-app.ps1
5367
```
5468

5569
The startup script will start two applications:
@@ -83,4 +97,4 @@ You've now cloned the repository you'll use for this workshop and have your IDE
8397
[template-repo]: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository
8498
[walkthrough-previous]: README.md
8599
[walkthrough-next]: ./1-add-endpoint.md
86-
[website-url]: http://localhost:4321
100+
[website-url]: http://localhost:4321

content/1-hour/1-add-endpoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It's standard to work in phases when adding functionality to an application. Giv
1313
The application uses a Flask app with SQLAlchemy as the backend API (in the [/server][server-code] folder), and an Astro app with Svelte as the frontend (in the [/client][client-code] folder). You will explore more of the project later; this exercise will focus solely on the Flask application.
1414

1515
> [!NOTE]
16-
> As you begin making changes to the application, there is always a chance a breaking change could be created. If the page stops working, check the terminal window you used previously to start the application for any error messages. You can stop the app by using <kbd>Ctl</kbd>+<kbd>C</kbd>, and restart it by running `./scripts/start-app.sh`.
16+
> As you begin making changes to the application, there is always a chance a breaking change could be created. If the page stops working, check the terminal window you used previously to start the application for any error messages. You can stop the app by using <kbd>Ctl</kbd>+<kbd>C</kbd>, and restart it by running the script appropriate for your operating system: `./scripts/start-app.sh` (macOS / Linux) or `./scripts/start-app.ps1` (Windows PowerShell).
1717
1818
## Flask routes
1919

0 commit comments

Comments
 (0)