Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/randomsearch18/marvellous-mapping-machine
A work-in-progress routing engine and web-based navigation app
https://github.com/randomsearch18/marvellous-mapping-machine
openstreetmap routing-engine
Last synced: about 17 hours ago
JSON representation
A work-in-progress routing engine and web-based navigation app
- Host: GitHub
- URL: https://github.com/randomsearch18/marvellous-mapping-machine
- Owner: RandomSearch18
- Created: 2024-11-19T17:28:59.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2025-01-19T14:43:06.000Z (about 22 hours ago)
- Last Synced: 2025-01-19T15:37:34.261Z (about 21 hours ago)
- Topics: openstreetmap, routing-engine
- Language: TypeScript
- Homepage: https://marvellous-mapping-machine.pages.dev/
- Size: 227 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Marvellous mapping machine
## Development instructions for backend
### Preparation
Ensure you have Python v3.10+ installed.
Clone the repository and change directory to the `backend` folder in this repository:
```bash
cd backend
```
### Virtual environment
Create a virtual environment. For example, on a personal computer running Linux, you can create a venv in the project directory:
```bash
python3 -m venv .venv
```
If you're on a school computer, you can't create a venv in your `H:` drive, so create it somewhere on the `C:` drive. E.g. in Git Bash:
```bash
py -m venv "$USERPROFILE/venvs/marvellous-mapping-machine"
```
Or in Powershell:
```powershell
py -m venv "$env:USERPROFILE\venvs\marvellous-mapping-machine"
```
### Activate the virtual environment
In VSCode, run the **Python: Select Interpreter** command. If the venv is in the project directory, you can directly select it from the list. If it's elsewhere, manually enter the path to the venv.
Alternatively, activate the venv in the terminal, e.g. in Linux:
```bash
source .venv/bin/activate
```
### Install dependencies
```bash
python -m pip install -r backend/requirements.txt
```
### Run the program
```bash
python backend/main.py
```
## Development instructions for frontend
### Preparation
Ensure you have Node.JS and Yarn v1 installed.
Clone the repository and change directory to the `frontend` folder in this repository:
```bash
cd frontend
```
### Install dependencies
Run:
```bash
yarn
```
### Start development server
Run
```bash
yarn dev
```
And access the frontend using the URL displayed in your terminal.
### Quirks
Note that Python code is only updated when the build tool starts (i.e. no live reload), so if you want to edit Python code while previewing the frontend, you should restart the Vite dev server after editing to see your changes.