forked from EyeTrackVR/ETVR-Backend
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b2993f7
commit b498ef0
Showing
1 changed file
with
38 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,38 @@ | ||
| # EyeTrackVR App Python Backend | ||
|
|
||
| This is the Python backend for the EyeTrackVR App. It is a FastAPI app that runs as an `exe` and communicates with the EyeTrackVR App via WebSockets. | ||
|
|
||
| ## Installation | ||
|
|
||
| This app uses a `vscode devcontainer` to run in a Docker container. This is the recommended way to run the app. If you want to run it outside of the container, you will need to install the dependencies using the provided poetry implementation. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Docker or Docker Desktop (windows - running on WSL2 backend) | ||
| - VSCode | ||
| - VSCode Dev Containers extension | ||
|
|
||
| ## Running the app | ||
|
|
||
| 1. Open the project in VSCode | ||
| 2. Open the command palette (Ctrl+Shift+P) | ||
| 3. Select `Dev-Containers: Reopen in Container` | ||
| 4. Open the command palette again | ||
| 5. Select `Python: Run Python File in Terminal` | ||
| 6. Select `main.py` | ||
|
|
||
| ## Running the app outside of the container | ||
|
|
||
| ### Install dependencies | ||
|
|
||
| **Note**: Make sure `make` is installed on your system. | ||
|
|
||
| 1. Open the project in VSCode | ||
| 2. Open a terminal (Ctrl+Shift+`) | ||
| 3. Run `make install` | ||
|
|
||
| ### Run the app | ||
|
|
||
| 1. Open the project in VSCode | ||
| 2. Open a terminal (Ctrl+Shift+`) | ||
| 3. Run `make` to run the app | ||
| # EyeTrackVR App Python Backend | ||
|
|
||
| This is the Python backend for the EyeTrackVR App. It is a FastAPI app that runs as an `exe` and communicates with the EyeTrackVR App via WebSockets. | ||
|
|
||
| ## Installation | ||
|
|
||
| This app uses a `vscode devcontainer` to run in a Docker container. This is the recommended way to run the app. If you want to run it outside of the container, you will need to install the dependencies using the provided poetry implementation. | ||
|
|
||
| ## Requirements | ||
|
|
||
| - Docker or Docker Desktop (windows - running on WSL2 backend) | ||
| - VSCode | ||
| - VSCode Dev Containers extension | ||
|
|
||
| ## Running the app | ||
|
|
||
| 1. Open the project in VSCode | ||
| 2. Open the command palette (Ctrl+Shift+P) | ||
| 3. Select `Dev-Containers: Reopen in Container` | ||
| 4. Wait for container to finish building (first time only) Open a terminal (Ctrl+Shift+`) | ||
| 5. Run `make` to run the app | ||
|
|
||
|
|
||
| ## Running the app outside of the container | ||
|
|
||
| ### Install dependencies | ||
|
|
||
| > **Note**: Make sure `make` is installed on your system. | ||
| 1. Open the project in VSCode | ||
| 2. Open a terminal (Ctrl+Shift+`) | ||
| 3. Run `make install` | ||
|
|
||
| ### Run the app | ||
|
|
||
| 1. Open the project in VSCode | ||
| 2. Open a terminal (Ctrl+Shift+`) | ||
| 3. Run `make` to run the app |