diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..337163c --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,4 @@ +{ + "name": "Python 3", + "image": "mcr.microsoft.com/devcontainers/python:1-3.12-bullseye" +} diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..90e0456 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: "devcontainers" + directory: "/" + schedule: + interval: weekly diff --git a/code/README.md b/code/README.md index aaa1f86..dcf7c08 100644 --- a/code/README.md +++ b/code/README.md @@ -2,7 +2,7 @@ ### Virtual Environment Setup -#### MacOS & Linux +#### MacOS, Linux and GitHub CodeSpaces ```console $ python3 -m venv env @@ -43,4 +43,11 @@ pytest ./deploy/tests/test_main.py ``` python -m http.server 5000 ``` +### Special Instructions for GitHub CodeSpaces + +If you are running on GitHub CodeSpaces, you will need to change the API_URL variable in the index.html to the URL assigned to your CodeSpace. + +For example, instead of `const API_URL = 'http://127.0.0.1:8000';`, change to `const API_URL = 'https://opulent-space-acorn-4q4pjwgv9wv27wx-8000.app.github.dev';` + +Refer to this [guide](https://docs.github.com/en/codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace) for more details