/ipv-menu-api

A simple API that wraps around the cafeteria's menu from ESTGV

Primary LanguageTypeScriptMIT LicenseMIT

ementas-api

A simple API that wraps around the cafeteria's menu from ESTGV

Table of Contents

Miscellaneous

Build Status Deployment License

Documentation

GET /estgv

// Example response
[
    {
        "date": "2020-02-03T00:00:00.000Z",
        "type": 0,
        "sopa": "Alho-Francês",
        "carne": "Panadinhos de frango à americana (com bacon) com arroz de",
        "peixe": "Solha no forno com batata e alecrim",
        "dieta": "Carne de vaca cozida com couve e batata",
        "vegetariano": "Fusili gratinado com cogumelos e legumes em juliana"
    },
    {
        "date": "2020-02-03T00:00:00.000Z",
        "type": 1,
        "sopa": "Macedónia",
        "carne": "Chili de carne vaca com arroz",
        "peixe": "Carapauzinhos fritos C/ arroz de tomate",
        "dieta": "Pescada assada ao natural com brócolos",
        "vegetariano": "Legumes salteados à Brás"
    }
]

Quick Start

Development

  1. Clean project 
    $ npm run clean
  2. Install dependencies 
    $ npm install
  3. Run development app 
    $ npm run dev

Production

  1. Clean project 
    $ npm run clean
  2. Install dependencies 
    $ npm install
  3. Build JavaScript 
    $ npm run build
  4. Run a clean install 
    $ npm clean-install --only=production

As you can see in config.env, some things are required for this server to work.

  1. 🌐 Zamzar API Key - read more about Zamzar

  2. 🚧 API URL - should be changed according to prod or dev environment

    :heavyexclamation_mark: This are all Node.js environment variables. While in _production the config.env will NOT be loaded, therefore this variables should be set at environment.