vcwild / tally

Tally is an application for restaurant inventory management. It is a mailing system that warns restaurant managers when a resource due date is about to expire.

Tally

Tally is an application for restaurant inventory management.

It is a mailing system that warns restaurant managers when a resource due date is about to expire. Created with Phoenix, Ecto, and a dockerized Postgres database.

Table of Contents

• API Methods
• API Endpoints
• Project Requirements
• License

API Methods

• Restaurant creation
• Supply creation
• Show supplies

Mailing

• Uses bamboo server as mailing framework

API Endpoints

Scope /api

Endpoint /restaurants

Description: create an user with an unique UUID.

Params:

name: a string with the user name

email: a valid e-mail account

Methods:

• POST

Body:

 {
    "name": String,
    "email": [e-mail],
}

Endpoint /supplies

Description: create a supply for the restaurant with an unique UUID.

Params:

restaurant_id: Restaurant Unique UUID

description: Supply description

expiration_date: Supply expiration date

in_charge: Person in charge of the supply

Methods:

• POST

Body:

 {
    "restaurant_id": String,
    "description": String,
    "expiration_date": String format YYYY-MM-DD,
    "in_charge": String
}

Endpoint /supplies/:id

Description: Get supply.

Response:

{
  "supply": {
    "description": "batata",
    "expiration_date": "2021-04-01",
    "in_charge": "potato guy",
    "restaurant_id": "88f4b2c8-b09f-4168-8fbd-559988ebb106",
    "id": "a4b47172-2e07-4cbc-b3bf-96bedd6a700b"
  }
}

Project Requirements

• Mix requirements
• Docker
• Docker compose
• Postgres database

Create Docker-Compose image from Docker Hub

docker-compose up -d

Install Phoenix from Mix archive

mix archive.install hex phx_new 1.5.7\

License

Distributed under the GPL 3. License. See LICENSE for more information.