This repository is where we (GOMOGI) write and host the INDRZ project documentation.
Here is the documentation for the Frontend, Backend content and the static-site generator code VuePress for the INDRZ documentation site. The project homepage indrz
Project homepage indrz, indrz enables you to serve indoor maps and provide shortest path routing to your users. (room to room, building to building, person to person)
indrz is composed of two parts hosted at GITLAB, mirrored to Github, active on GitLab indrz-frontend code and indrz-backend code
- indrz-frontend code is the frontend repository built with Vue, Nuxt and Vuetify
- indrz-backend code is the backend repository serving the API built with Django, Django Rest Framework
--- NOTE work in progress--
git clone https://github.com/indrz/indrz-be.git indrz
cd indrz-beThe prefrered quick start is using docker-compose. Simply enter the main directory where you cloned the repo and enter:
docker-compose up -d
It then creates the following:
- Postgresql database instance with both PostGIS and PgRouting extensions
- Python container to run the backend Django application
- Frontend nodejs container to run the frontend Vue, Nuxt application
- Geoserver container to serve your maps
git clone https://github.com/indrz/indrz-be.git indrz
cd indrz-bepip install -r requirements.txt
python manage.py migrate --noinput
python manage.py loaddata initial_ltspacetype_data
python manage.py loaddata initial_poi_categories
python manage.py loaddata buildings--to-do--
Documentation is built with VuePress.
Start documentation site in development mode:
yarn run dev
yarn run build
Backend
- Django – Web Framework Backend
- Django Rest Framework – Django Rest Web Framework our API
- PostGIS – Spatial Database extension to Postgresql
- PGRouting - Routing extension to PostGIS and Posgresql
- Postgresql – Database
- Geoserver – Web map server to serve and create, maps and data
Frontend
- Openlayers – Slippy client side javascript mapping library
- Vue.js Vue.js frontend framework
- Nuxt.js vue based frontend framework
- Vuetify Vuetify Vue Material Design building blocks
- Material Design - design
indrz is under LICENCE GNU General Public License v3.0. The name "indrz" is a trademark and cannot be used without approval.
Find it fast
To make indoor navigation as common as GPS car navigation.
indrz is open source software API to provide indoor maps and routing directions.
indrz will allow you to integrate indoor maps and routing services into your homepage or application.
If you work at a university or other organization and need an online wayfinder indrz.com
will offer our services to build or host it for you. Our business model is like Mapbox, free open source software
and payed services such as data conversion, preparation or import. The indrz.com cloud based
platform can host the solution for you.
Indrz was developed out of the need to quickly communicate how to get from point A to point B in a complex set of buildings. Being late for your first class is never a good thing, so to help the students out indrz was born.
Communication is simple via email (office@gomogi.com). All other discussion should happen relevant GitHub issues page.
indrz would love your help. There are more than enough things to get done so we would love your help. We need people to help out submit bugs, suggest features, write documentation and contribute code.
Contact: Michael Diener
Email: office@gomogi.com
[www.gomogi.com] (https://www.gomogi.com)
The code is for building the routing services, client side javascript to view routes, show maps, integrate maps, change floors, ... All the functionality is baked in for your own indoor routing app or webpage.
You do not get the data prepared for the system, data import, data conversion, platform installation, design and more. These are all services provided by GOMOGI (maybe others in the future :) ) on the cloud platform here at (www.indrz.com) so to keep this all open source please contact us to keep things moving forward.
We can do this for you but if you know how you will need to know how to make the maps, import data, convert file formats such as DWG,JPG, PDF into maps or does it upload into a PostGIS database. This is hard work and I am still looking for a quick magicical way to automagically import your indoor maps (simple images is easy and everyone can do that). Finally you also need to build the indoor routing network.
- import CAD, JPG, PDF,PNG... into PostGIS
- create maps (geoserver with sld) coming from your import Data
- create routes (QGIS or other Desktop GIS)
- create Client (indrz)
- create Services (indrz)
- customize Client, corporate identity
- deploy
- universities
- hospitals
- business parks
- shopping malls
- expo halls
- events opera house, stadiums
- libraries
- any building anywhere
- meeting room finder
- digital wayfinding
- search people, places
- API connect to external data such as room booking systems vi API
- API to show or hide map components
- floor switcher to view floor plans per floor
- routing indoor 3d routes from any floor to any floor
- routing for diabled
- routing walk time
- routing distance
- routing logic such as route to front office first then to destination
- 3D view in google earth connected to 2d map
- Print maps
- share map, share route, share search results
- Points of interests: cafe, vending machines, bookstore you name it
- multilanguage to support any language
- mobile web page
Translations are hosted by [Transifex here] (https://www.transifex.com/organization/indrz/dashboard) Currently we have translations for English and German, feel free to add your language.
- indrz Wirtschafts Universität Wien indrz-campus (http://campus.wu.ac.at)
- indrz library Vienna University of Economics and Business Administration Library
- indrz business park Lakeside Science & Technology Park
- indrz Alpen Adria University Klagenfurt indzr-campus (http://campus-gis.aau.at)
Communication is simple via email (office@gomogi.com). All other discussion should happen in the indrz Google Group, or relevant GitHub issues page.
indrz would love your help. There are more than enough things to get done so we would love your help. We need people to help out submit bugs, suggest features, write documentation and contribute code.
| Task | Skill |
|---|---|
write documentation |
anyone |
write translations |
multi-lingual |
submit bug report |
write detailed |
fix bugs |
git, coding |
add features |
git, coding |
A big shout out to the following supporters for sharing the open source love
- [Browserstack] (https://www.browserstack.com) for testing our mobile and desktop browser compatibility
- [Transifex] (https://www.transifex.com/) for translations
Indrz is built for pure simplicity and quick information exchange. A user visiting a site should quickly see their destination and orient themselves. Indrz is not designed as a virtual reality app guiding you every step of the way but more like a quick reference. You still will need to look around, but getting lost and walking into pillars while staring at your phone should no longer happen.
We are looking to expand our horizons
- Auto generating indoor route descriptions based on points of interest and landmarks is an area in need of more research.
- Semi-Automatic data conversion from DWG, DXF, PDF, JPG to PostGIS vector polygons, lines, and points.
- Generation of polygon centerlines, skeletons
- Complex topology rule checking
We want to make sure every one can find there way with ease and make them aware of how wayfinding works teaching you at the same time how to find your way in any and every indoor environment.