lan

(โ˜… 566)

Internet of Things Server Layer with CoAP, WebSocket, MQTT, HTTP Protocol.

  • .bowerrc
  • .editorconfig
  • .gitignore
  • .gitmodules
  • .jscsrc
  • .jshintrc
  • .travis.yml
  • app.js
  • bower.json
  • Dockerfile
  • gulpfile.js
  • jobs
  • LICENSE
  • package.json
  • prepare.sh
  • README.md
  • server.js
  • yarn.lock

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/phodal/lan

Downloads the entire project code from GitHub to your computer.

cd lan

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Node.js Node.js must be installed to use npm.
npm install -g sequelize-cli

Installs the package published on the npm registry globally โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build .

Builds a runnable image based on the Dockerfile.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install --save bcrypt

Downloads and installs the libraries listed in package.json.

npm install

Downloads and installs the libraries listed in package.json.

npm install -g sequelize-cli

Installs the package published on the npm registry globally โ€” no need to clone the source.

npm start

Starts the development/run server.

npm install --production

Downloads and installs the libraries listed in package.json.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation