Giter Site home page Giter Site logo

future-mobility's Introduction

future-mobility

An exhibit about the Future of Mobility.

Compilation

To install the required dependencies run npm install in both the root directory and the server directory.

You can use npm run build or npm run watch in the root directory to build the client apps. The server does not require compilation.

The .env file in the root directory contains settings that are applied at compilation time.

Running

Start the server by running npm run start in the server directory.

The clients, in the root directory, are:

  • city.html: Presents the city map, to be projected over the exhibition table.
  • dashboard.html: Shows the auxiliary touchscreen dashboard that displays variables and goals, and allows selecting Power-Ups.
  • editor.html: An editor that pushes changes to the server. Note that it doesn't read updates from the server, so it's not possible to use multiple editors simulatenously. It's only meant for use during development.

Configuration

The main configuration file is config.yml. The server has to be reloaded after any changes. Clients get the configuration from the server through the http API and have to be reloaded after the server to take any changes.

The .env file has other configuration keys that affect the environment.

Server APIs

The server has both an HTTP and a WebSocket API. Their specifications are:

  • http: specs/openapi.yaml
  • ws: specs/asyncapi.yaml

You can use Swagger Editor and the AsyncAPI Playground to format the respective specifications in a friendly format.

License

Copyright (c) 2021 IMAGINARY gGmbH Licensed under the MIT license (see LICENSE) Supported by Futurium gGmbH

future-mobility's People

Contributors

andreasdanielmatt avatar elondaits avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.