Map engine to serve all the people :)
Project description
Good Map
Map engine to serve all the people ;)
Running App locally
Configuration
Rename config-template.yml to config.yml and change it's contents according to your needs. Values descriptions you can find inside config-template.yml.
Backend
All dependencies are specified in pyproject.toml file. To install them in your onw environment:
- go to project directory
- use
poetry install
- get into poetry shell
poetry shell
- Run
FLASK_ENV=development;FLASK_APP=goodmap.goodmap flask run
Frontend (optional)
In production environment javascript is served as static files, but for ease of development you can run javascript server locally:
- go to frontend directory
- install all dependencies with
nmp install
- run server with
npm run serve
- set
development_overwrites
for wanted endpoints, otherwise application will use compiled files.
Database
Database consists of three sections:
categories
- which informs on what categories data of points is dividedvisible_data
- list of categories which will be visible by application usersdata
- actual data splitted intocategories
categories
Fully configurable map where key is name of category and value is list of allowed types. E.g.
- "car_elements": ["mirror", "wheel", "steering wheel"]
- "color": ["red", "blue", "green"]
data
Data consists of two parts:
- obligatory and constant
name
- name of the objectposition
- coordinates of object
- category dependent - depending on your
categories
setup it varies. See example of config below.
Examples
You can find examples of working configuration and database in tests/e2e_tests
named:
e2e_test_config.yml
e2e_test_data.json
Version History
0.1 - Initial Release - in development
0.1.5 - in development
- better looking frontend
0.1.4 - Makeover
- frontend for mobile version
0.1.3 - Simplification
- Simplified and standarized configuration in code
- Extracted project dependencies to other repositoriesq
- Updated dependencies
0.1.1 - Static frontend
- Using frontend served in npm
0.1.0 - First working version
- JSON and Google hosted JSON database
- Map displays points from database
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.