Add description for mac/linux
This commit is contained in:
parent
3288d14c33
commit
77ad8e3f29
21
README.md
21
README.md
@ -67,6 +67,15 @@ pip install -r requirements.txt
|
|||||||
python app.py
|
python app.py
|
||||||
```
|
```
|
||||||
|
|
||||||
|
For mac/linux
|
||||||
|
```bash
|
||||||
|
cd backend
|
||||||
|
python -m venv .venv
|
||||||
|
source .venv/bin/activate
|
||||||
|
pip install -r requirements.txt
|
||||||
|
python app.py
|
||||||
|
```
|
||||||
|
|
||||||
If the virtual environment already exists, you can skip `python -m venv .venv`.
|
If the virtual environment already exists, you can skip `python -m venv .venv`.
|
||||||
|
|
||||||
The backend should show:
|
The backend should show:
|
||||||
@ -80,8 +89,14 @@ Leave this terminal running.
|
|||||||
### Frontend Setup
|
### Frontend Setup
|
||||||
|
|
||||||
Open a second terminal from the project root:
|
Open a second terminal from the project root:
|
||||||
|
Windows:
|
||||||
```powershell
|
```powershell
|
||||||
|
.\backend\.venv\Scripts\Activate.ps1
|
||||||
|
python -m http.server 8000
|
||||||
|
```
|
||||||
|
Linux/Mac
|
||||||
|
```bash
|
||||||
|
source backend/.venv/bin/activate
|
||||||
python -m http.server 8000
|
python -m http.server 8000
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -101,7 +116,8 @@ Keep both terminals open while using the app.
|
|||||||
4. Register or log in.
|
4. Register or log in.
|
||||||
5. Use the map and blog pages.
|
5. Use the map and blog pages.
|
||||||
|
|
||||||
If backend code changes, restart the backend with `Ctrl + C` and run `python app.py` again. If frontend HTML/CSS/JS changes, usually a hard browser reload is enough: `Ctrl + Shift + R`.
|
If backend code changes, restart the backend with `Ctrl + C` and run `python app.py` again.
|
||||||
|
If frontend HTML/CSS/JS changes, usually a hard browser reload is enough: `Ctrl + Shift + R`.
|
||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
- HTML
|
- HTML
|
||||||
@ -112,6 +128,5 @@ If backend code changes, restart the backend with `Ctrl + C` and run `python app
|
|||||||
- Leaflet / OpenStreetMap
|
- Leaflet / OpenStreetMap
|
||||||
|
|
||||||
## Members
|
## Members
|
||||||
- Flepp Stiafen
|
|
||||||
- Kohler Joshua
|
- Kohler Joshua
|
||||||
- Ruegger Andre
|
- Ruegger Andre
|
||||||
Loading…
x
Reference in New Issue
Block a user