Code Monkey home page Code Monkey logo

beer-tap-dispenser's Introduction

Birrita Project

This project is named Birrita. A Postman collection file has been provided for testing purposes. Additionally, Swagger has been integrated into the project, providing a means to interact with the API directly, which is available at the /api path.

A JWT login system has been developed, restricting the ability to create new beer dispensers to admin users only.

Authentication is not required for the rest of the endpoints.

A CRON job has been implemented to monitor tap opening times, and certain limits have been established for litres per person and maximum tap opening time in order to make the solution more closely resemble a real-world scenario.

Writes have been implemented with transactions for enhanced security.

Setup and Run

To setup and run the project, use the following commands:

  1. Install the necessary packages:
npm install
  1. Run the project:
npm run start

Testing with Postman

A Postman collection has been included in the repository for testing the API endpoints. Import the collection into Postman and execute the requests.

Swagger API Documentation

The Swagger API documentation is available at /api path on the running server. You can interact with the API directly using Swagger.

JWT Authentication

JWT authentication is used to restrict the ability to create new beer dispensers to admin users only. Use the login endpoint to authenticate.

CRON Job

A CRON job runs regularly to monitor and enforce limits for litres per person and maximum tap opening time.

Transactional Writes

Writes to the database are handled with transactions to ensure data integrity and consistency.

beer-tap-dispenser's People

Contributors

damianlluch avatar rviewer-team avatar

Stargazers

José Antonio 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.