Skip to content

Commit c4eb371

Browse files
committed
Update docs
1 parent 8dc6789 commit c4eb371

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This method requires running [VSCode](https://code.visualstudio.com/) on your ma
2929
This repository includes a [Dev Container config](./.devcontainer/devcontainer.json) (more about [Dev Containers](https://containers.dev/)) that declares all of the dependencies that you need to build and run the example. Dev Containers can be started locally with VSCode, but we recommend using GitHub's [Codespaces](https://github.com/features/codespaces) to quickly launch the Dev Container:
3030

3131
1. Right-click to create a Codespace in a new tab or window:
32-
* [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/reboot-dev/reboot-todo-starter)
32+
* [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/reboot-dev/reboot-todo-python)
3333
* *Important*: In order to view the example's front end, you must connect your local VSCode to the codespace: you cannot use VSCode in a browser window.
3434
2. Go to [https://github.com/codespaces](https://github.com/codespaces) and click the three dots next to the codespace you just created and then click `Open in Visual Studio Code`.
3535
* You can [set your default editor to VSCode for codespaces](https://docs.github.com/en/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces) to avoid this step in the future. See [these instructions](https://docs.github.com/en/codespaces/developing-in-codespaces/opening-an-existing-codespace?tool=vscode) for more information.
@@ -44,8 +44,8 @@ Running directly on a host requires:
4444
- A platform of either:
4545
- `x86_64 Linux` with `glibc>=2.35` (Ubuntu Jammy and other equivalent-generation Linux distributions)
4646
- `arm64 or x86_64 MacOS` with `MacOS>=13.0` and `Xcode>=14.3`
47-
- Node.js
48-
- Including `npm`.
47+
- Python >=3.10
48+
- Node.js (for the front end)
4949
- Docker
5050
- Note: the example does not run "inside of" Docker, but Docker is used to host a native support service for local development.
5151

@@ -58,18 +58,19 @@ Now you're ready to [run the application](#run-the-application)!
5858

5959
### Backend
6060

61-
Our backend is implemented in TypeScript and we must install its dependencies before
61+
Our backend is implemented in Python and we must install its dependencies before
6262
running it.
6363

6464
```sh
65-
npm install
65+
python3 -m venv ./.venv && source .venv/bin/activate && pip install -r requirements.txt
6666
```
6767

6868
#### Run the backend
6969

70-
Then, to run the application, you can use the Reboot CLI `rbt`:
70+
Then, to run the application, you can use the Reboot CLI `rbt` (but only within the virtual environment you set up above):
71+
7172
```shell
72-
npx rbt dev run
73+
rbt dev run
7374
```
7475

7576
Running `rbt dev run` will watch for file modifications and restart the
@@ -80,8 +81,9 @@ arguments that get expanded when running `rbt dev run`.
8081

8182
To run the front end, open a separate terminal/shell and do:
8283
```shell
84+
npm install
8385
npm run dev:web
8486
```
8587

8688
If using VSCode, the page will load automatically.
87-
If not using VSCode, visit [http://127.0.0.1:3000](http://127.0.0.1:3000)`.
89+
If not using VSCode, visit [localhost:3000](http://localhost:3000)`.

0 commit comments

Comments
 (0)