taffarelxavier/apirest

Api rest do Sistema

Application REST - Adonis API

A aplicação REST de todo o sistema.

1. NPM install
2. Run application
3. Access
4. Database Documentaion

Installation

📌 Clone the reposity

git clone https://github.com/[YOUR_USER_NAME]/apirest

📌 Install with npm

Use the npm command to install the packges node

npm install

📌 Run App

Use the adonis command run and start the application

adonis serve --dev

📌 Access

Access, in browser, the address http://127.0.0.1:[PORT_NAME]

---

Database Documentation

Conceitual Model:

Logic Model:

---

Entities:

• Address
• Categories
• Cities
• Companies
• Files
• Contacts
• Itens_Request
• Products
• User_Requests
• Stocks
• Users
• Ufs

Below, is description from entities databases in System.

📌 Address

Description

This table is accountable for register address of the system users.

Attributes

• address_id
• street
• district
• city_id

---

📌 Address_User_Company

Description

This table is accountable for register address of the system users.

Attributes

• add_id
• type_user : ENUM(user, company)
• number (O número da casa)
• user_id

---

📌 Categories

Description

Esta tabela é responsável por cadastrar as categorias dos produtos.

Attributes

• category_id
• category_name

---

📌 Cities

Description

Esta tabela terá as cidades já pré-cadastradas, no sistema. Por meio dessa tabela...

Attributes

• city_id
• city_name
• uf_id

---

📌 Companies

Description

Esta tabela é responsável por cadastrar as empresas.

Attributes

• company_id
• fantasy_name
• cnpj
• logo
• user_id

---

📌 Contacts

Description

Esta tabela é responsável por cadastrar os contatos.

Attributes

• contact_id
• number_phone
• type_user : ENUM(user, company)
• user_id

---

📌 Files

Description

Esta tabela é responsável por incluir os arquivos.

Attributes

• file_id
• file
• name
• type

---

📌 Itens_Request

Description

Esta tabela conterá os itens do pedido do cliente.

Attributes

• item_request_id
• item_amount
• item_prince
• item_subtotal
• request_id
• product_id

---

📌 Products

Description

Esta tabela é responsável por cadastrar os produtos.

Attributes

• product_id
• image
• name
• description
• company_id
• category_id

---

📌 User_Requests

Description

Esta tabela é responsável por cadastrar o pedido do cliente.

Attributes

• request_id
• date
• req_status (1, 2, 3, 4), default: 1
• user_id
• compay_id

---

📌 Itens_Request

Description

Esta tabela é responsável por cadastrar as categorias das empresas.

Attributes

• item_req_id
• item_amout
• item_price
• item_subtotal
• item_req_id
• item_product_id

---

📌 Stocks

Description

Esta tabela é responsável por cadastrar a estoque dos produtos.

Attributes

• stock_id
• stock_product_price
• stock_amount
• stock_measure_type
• stock_product_id

---

📌 Users

Description

Esta tabela é responsável por cadastrar os usuários.

Attributes

• user_id
• user_name
• user_password
• user_token
• user_address_id
• user_city_id -

---

📌 UFs

Description

Esta tabela é responsável por conter as Unidades Federativas.

Attributes

• uf_id
• uf_name