GithubHelp home page GithubHelp logo

atoms's Introduction

Atoms

React exercise with a simple emergency light management systems. The backend is provided, but the frontend is yours to do.

Backend

Start with npm start.

There are several end-points to manage the system.

Users

Users can have one of two roles: ADMIN or USER. All end-points (except login) require authentication. Some end-points require the user to have the ADMIN role.

  • /user (GET): returns all the users.
  • /user/<id> (GET): returns a single user.
  • /user (POST): creates a new user (ADMIN restricted).
    Request body should contain a JSON object with name, password, and role.
  • /user/<id> (PUT): edits a user (ADMIN restricted).
    Request body should contain a JSON object with name, password, or role.
  • /user/<id> (DELETE): deletes a user (ADMIN restricted).
  • /me (GET): returns the current user.
  • /login (POST): logs in a user.
    Request body should contain a JSON object with name and password.
  • /logout (POST): logs out the user.

Blocks

Blocks represent emergency lights that can be remotely tested. They can have different statuses: NOT_TESTED, TESTING, PASS, BATTERY_ISSUE, LIGHT_ISSUE.

  • /block (GET): returns all the blocks.
  • /block/<id> (GET): returns a single block.
  • /block (POST): creates a new block (ADMIN restricted).
    Request body should contain a JSON object with name and location.
  • /block/<id> (PUT): edits a block (ADMIN restricted).
    Request body should contain a JSON object with name or location.
  • /block/<id> (DELETE): deletes a block (ADMIN restricted).
  • /block/<id>/test (POST): starts a test. The tes will complete after one minute.
  • /block/<id>/report (POST): reports a status (usually an issue).
    Request body should contain a JSON object with the status.

atoms's People

Contributors

alightgoesout avatar dylan-bs avatar

Watchers

James Cloos 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.