README.md

IndoorGML Editor ~ InEditor

A web-based editor for drawing and creating OGC IndoorGML data
About IndoorGML · View Demo · Wiki

IndoorGML-Editor is an open source Javascript program that provides tools for simple editing IndoorGML data. To create IndoorGML documents we use InFactory Restful API.

👉 Check more detail about IndoorGML-Editor here

Getting Started

Prerequisites

1. OS : Windows recommended. The exe file based on the Windows(val3dity) is used for simple geometry validation.
2. Node.js : You need to install Node.js and set PATH
   • link
3. Maven : over 3.5 version. You need to install Maven and set MAVEN_HOME & PATH for InFactory
   • How to set MAVEN_HOME : link for Window , link for Linux
   • If you do not want to install Maven, check Maven wrapper at InFactroy.
4. Java : JDK over 1.8 version. You need to install JDK and set JAVA_HOME & PATH.
   • JAVA 8; not working at the upper version
   • How to set JAVA_HOME : link

Installation

1. Clone or Download this repository.

   git clone https://github.com/STEMLab/InEditor.git
   

   

2. Install NPM packages

   npm install
   

3. Start server

   npm start
   

4. Launch a web browser and open InEditor http://127.0.0.1:5757

5. In order to create IndoorGML documents, you must install InFactory that a restful server and library to create OGC IndoorGML

   1. Clone or Download this repository.
      • Download project : You can download zip file from https://github.com/STEMLab/InFactory
      • Clone

        git clone https://github.com/STEMLab/InFactory.git
        

   2. Build Project : Open command prompt on project folder and build project
      • If you install maven and set PATH,

        mvn clean install
        

      • If not,

        ./mvnw clean install
        

   3. Start API Server : Start server
      • If you install mavend and set PATH,

        mvn jetty:run "-Djetty.port=9797"
        

      • If not,

        ./mvnw jetty:run "-Djetty.port=9797"
        

Usage

A simple example to create IndoorGML document include one cellspace.

1. Add a new floor.
   
2. Add a new cellspace.
   
3. Export to InFactory.
   
4. You can check downloaded document on InViewer-Desktop(unity) or InViewer(web).
   

👉 For more information about usage, check the User Guide or Wiki

Extention

The project on master branch supports generating IndoorGML data for core module and following extensions.

1. Navigation Extension
2. Non-Navigable Space Extension
3. Storey Extension → will be supported
4. POI Extension → will be supported

The editor for other extensions will be created in an additional branch.

License

This project is licensed under the MIT licenses. - see the LICENSE file for details