Skip to content

Latest commit

 

History

History
106 lines (84 loc) · 5.1 KB

Readme.md

File metadata and controls

106 lines (84 loc) · 5.1 KB
Raw

UD-Viz : Urban Data Vizualisation

UD-Viz is a JavaScript library based on iTowns, using npm and published on the npm package repository, allowing to visualize, analyse and interact with urban data.

A tutorial of the game engine can be found here

Pre-requisite

Developing UD-Viz requires some knowledge about JS, node.js, npm and three.js.

Install npm

For the npm installation refer here

Required npm version: UD-Viz has been reported to work with npm versions npm 6.X and npm 7.X.

Installing the UD-Viz library per se

git clone https://github.com/VCityTeam/UD-Viz.git
cd UD-Viz
npm install

Try examples

cd PATH_TO_UD-Viz
npm run build
cd /
git clone https://github.com/VCityTeam/UD-SimpleServer
cd UD-SimpleServer
npm install
node index.js PATH_TO_UD-Viz 8000

Developers

Recommended IDE

Installing Visual Studio Code is recommended, in order to use the plugin formatter Prettier. Once installed you should setup Prettier with single quote coding style (Preferences => Settings => Type in search bar : Single quote => Toggle single quote of Prettier extension)

Workflow

Before pushing your modifications to the origin repository please run:

npm run travis

in order to assert that eslint and webpack commands are still effective

Tip for Windows developers: eslint requires Linux style newline characters which are often overwritten in Windows environments. Although this is automatically resolved by Git when pushing code, eslint may detect "incorrect" newline characters when running locally. To attempt to fix this you may need to run npm run eslint -- --fix.

Sources directory layout (organizational principles)

Definitions:

UD-Viz (repo)
├── src                         # All the js sources of UD-Viz JS library
|    ├── Components             # A set of components used by sub-directories at this level
|    ├── Templates              # Classes builded with other sub-directory (Game, Widgets, Views) to propose application model
|    ├── Views                  # Classes of 3D views encapsulating the itowns view
|    ├── Game                   # A sub-directory offering game engine functionnality
|    |    ├── Shared            # code that can be executed both and client and server side to simulate a world
|    |               
|    └── Widgets                # A sub-directory gathering a set web web widgets (UI)  
|         ├── Widget_1
|         ├── Widget_2
|         ├── ...
|         └── Extensions        # Widgets depending on an external web service  
├── ...
└── webpack.js

Notes:

  • The position of a specific component in the sub-folder hierarchy reflects how it is shared/re-used by sub-directories. For example if a given component is only used by a single widget, then it gets defined within that widget folder. But when another component usage is shared by two widgets then its definition directory gets promoted at the level of the two widgets 
    └── src         # holds all the js sources that will be build
     ├── Components 
     |    └── Component_1         # A component shared by the Game and Widgets sub-directories
     |         └── *.js ...       # Component definition
     ├── Game
     |    └── Shared      
     |         └── Component_2    # A component used by the Shared sub-set of the Game sub-directory 
     |              └── ...       
     └── Widgets  
          ├── Components
          |    └── Component_3    # A component shared by at least two widgets 
          |         └── ...      
          └── Widget_1     
               └── Component_4    # A component only used by Widget_1 (of the Widgets sub-directory) 
                    └── ...