Skip to content

Commit 91dfbf1

Browse files
authored
Added support for GitHub Codespaces (#69)
* Create devContainer.json * setup script & readme instructions for Codespaces
1 parent dcf027f commit 91dfbf1

File tree

3 files changed

+31
-0
lines changed

3 files changed

+31
-0
lines changed

.devcontainer/devcontainer.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"name": "PythonBuddy",
3+
"image": "mcr.microsoft.com/vscode/devcontainers/python:3.7",
4+
"features": {
5+
}
6+
}

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@ Online Python 3 Programming with Live Pylint Syntax Checking!
66
![](gifs/demo.gif)
77

88
### Usage
9+
10+
**GitHub Codespaces**
11+
12+
The quickest way to use PythonBuddy is to launch your own GitHub Codespace!
13+
14+
1) From the GitHub repo, click the green "Code" button and select "Codespaces".
15+
2) Create a new Codespace or select a previous one you've already created.
16+
3) Navigate to the new tab created for your Codespace.
17+
4) In terminal, run `bash ./setup.sh`
18+
5) Click "Open in Browser" in the bottom right corner after the setup is complete.
19+
* The website may take a while to load or error at first while GitHub sets up the preview environment. In this case, reload the website.
20+
6) Remember to **stop your workspace** after you're done using it.
21+
22+
**Local Use**
23+
24+
Due to Codespace's monthly limits, it's recommended to run PythonBuddy locally if used often.
25+
926
1) Fetch from repo:
1027
```
1128
git clone https://github.com/ethanchewy/PythonBuddy.git

setup.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/bin/bash
2+
3+
FLASK_APP=app.py
4+
5+
pip install -r requirements.txt
6+
7+
cd PythonBuddy
8+
flask run

0 commit comments

Comments
 (0)