Giter VIP home page Giter VIP logo

musala-soft-gateway-task's Introduction

Description

This sample project is managing gateways - master devices that control multiple peripheral devices. Your task is to create a REST service (JSON/HTTP) for storing information about these gateways and their associated devices. This information must be stored in the database. When storing a gateway, any field marked as “to be validated” must be validated and an error returned if it is invalid. Also, no more that 10 peripheral devices are allowed for a gateway. The service must also offer an operation for displaying information about all stored gateways (and their devices) and an operation for displaying details for a single gateway. Finally, it must be possible to add and remove a device from a gateway.

Each gateway has:

  • a unique serial number (string),
  • human-readable name (string),
  • IPv4 address (to be validated),
  • multiple associated peripheral devices. Each peripheral device has:
  • a UID (number),
  • vendor (string),
  • date created,
  • status - online/offline.

Setup

Make sure to follow all these steps exactly as explained below. Do not miss any steps or you won't be able to run this application.

Install MongoDB

To run this project, you need to install the latest version of MongoDB Community Edition first.

https://docs.mongodb.com/manual/installation/

Once you install MongoDB, make sure it's running.

Install the Dependencies

Next, from the project folder, install the dependencies:

npm i

Populate the Database

node seed.js

Run the Tests

You're almost done! Run the tests to make sure everything is working:

npm test

All tests should pass.

Start the Server

node index.js

This will launch the Node server on port 3000. If that port is busy, you can set a different point in config/default.json.

Project structure

|── config
│   ├── default.json
│   └── test.json
├── middlewares
│   └── async.js
|   └── error.js
|   └── validateObjectId.js
├── models
│   ├── gateway.js
│   └── device.js
├── routes
│   └── gateways.js
├── tests
│   └── post.test.js
├── index.js
├── seed.js
├── package.json
├── README.md
└── ...

API endpoints:

REQUEST URL Description
GET /api/gateways Get all gateways
POST /api/gateways Create new gateway
GET /api/gateways/:id Get gateway by id
PUT /api/gateways/:id Update exist gateway
DELETE /api/gateways/:id Delete exist gateway
POST /api/gateways/:id/devices Add new device to exist gateway
DELETE /api/gateways/devices/:id Delete exist device

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.