Giter VIP home page Giter VIP logo

flash-comm's Introduction

Flash-Comm Server

Installation

  1. Clone repository to your device.
git clone https://github.com/austinginn/flash-comm.git
  1. Navigate to server directory.
cd flash-comm/server
  1. Install dependencies
    • Socket.io
    • Express
npm install

Web UI

A precompiled web app is included in this repository and will run out of the box. If you want to build the web UI from scratch, the repository can be found here.

Client Example

Only one active repository currently for nodejs, found here

Configuration

The flash-comm server lets you define spaces in a spaces.json file. If you run the server before creating spaces.json, one will be created for you with generic space naming. You can always modify this in the future.

  1. Create a spaces.json file with at least one space.
touch spaces.json
nano spaces.json
  1. The spaces.json file should be formated like this:
[
    {
        "id": "someUniqueID",
        "name": "human readable space name",
        "flash": false
    },
    {
        "id": "someUniqueID2",
        "name": "human readable space name 2",
        "flash": false
    },
    ...
]
  1. A devices.json file is created on first run. Edit this file if you need to modify a device or want to manually enter a device.

Usage

npm start

By default the server runs on port 3000. You can pass a port as the first argument.

npm start --port=3001

In a production environment, use a process manager like PM2 to run the server.

flash-comm's People

Contributors

austinginn avatar

Watchers

 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.