Skip to content

Latest commit

 

History

History
156 lines (128 loc) · 5.87 KB

Readme.md

File metadata and controls

156 lines (128 loc) · 5.87 KB
Raw

Purchase orders for stock replenishment

How to run the project

Requirements

  • docker
  • docker-compose
  • Python

Run the project

  • Start the docker engine
  • Clone the repository
  • run pip install psycopg2-binary
  • run docker-compose up --build
  • wait that in the terminal appears the log database system is ready to accept connections
  • run python init_db.py
  • open the browser and go to http://localhost:3000/

Functional analysis

Narrative

  • As a shop seller I want to see the list of suppliers of a certain quantity of a product so that I can see for each supplier the total cost and shipping days
  • As a shop seller I want the cheapest is highlighted so that I can see the min of all the costs
  • As a shop seller I want the see all the actual and future offers for each article of the suppliers so that I can wait the period in witch the cost is lower
  • As a shop seller I want update the data of a product in case of changes so that I can see always the actual data

Acceptance criteria

  • Given the main page When the shop seller fill the form with the product name and the quantity and click on the button "Search" Then the page show the list of suppliers with the total cost, shipping days, the list of offers and highlight the cheapest
  • Given the page in which update the data of the products When the shop seller enter on this page Then the page show the list of all the products
  • Given the page in which update the data of the products When the shop seller click on the button "Add supplier" Then the page show the form to add a new supplier
  • Given the page in which update the data of the products When the shop seller click on the button "Add product" Then the page show the form to add a new product
  • Given the page in which update the data of the products When the shop seller click on the button "Add offer" Then the page show the form to add a new offer

Architecture

Database

I choose postgresql to make a relational db. The database is composed by 6 tables:

  • supplier: it contains the info of the suppliers
  • product: it contains the info of the products
  • stock: it represents the relation between the suppliers and the products, the quantity left in the stock, the retail price and the shipping time
  • discount_n_pcs_based: it contains the percentage discount if the quantity of the product is greater than min_quantity
  • discount_tot_cost_based: it contains the percentage discount if the total cost of the order is greater than min_tot_cost
  • discount_time_based: it contains the percentage discount if the date is between date_start and date_end

This is the ER diagram of the database: ER diagram

Here there are the detailed columns and the referential integrity constraints of the tables:

  CREATE TABLE supplier (
      id SERIAL PRIMARY KEY NOT NULL,
      name VARCHAR(255) NOT NULL UNIQUE,
      address VARCHAR(255),
      phone VARCHAR(40),
      email VARCHAR(255)
  );
  CREATE TABLE product (
      id SERIAL PRIMARY KEY NOT NULL,
      name VARCHAR(255) NOT NULL UNIQUE,
      description text
  );
  CREATE TABLE stock (
      id SERIAL PRIMARY KEY NOT NULL,
      id_supplier INTEGER NOT NULL,
      id_product INTEGER NOT NULL,
      quantity INTEGER DEFAULT 0,
      price INTEGER NOT NULL,
      shipping_time INTEGER NOT NULL,
      
      CONSTRAINT fk_supplier
          FOREIGN KEY (id_supplier)
          REFERENCES supplier (id)
          ON DELETE CASCADE,
      CONSTRAINT fk_product
          FOREIGN KEY (id_product)
          REFERENCES product (id)
          ON DELETE CASCADE
  );
  CREATE TABLE discount_n_pcs_based (
      id SERIAL PRIMARY KEY NOT NULL,
      id_stock INTEGER NOT NULL,
      min_quantity INTEGER NOT NULL,
      discount_percentage INTEGER NOT NULL,
      
      CONSTRAINT fk_stock
          FOREIGN KEY (id_stock)
          REFERENCES stock (id)
          ON DELETE CASCADE
  );
  CREATE TABLE discount_tot_cost_based (
      id SERIAL PRIMARY KEY NOT NULL,
      id_stock INTEGER NOT NULL,
      min_tot_cost INTEGER NOT NULL,
      discount_percentage INTEGER NOT NULL,
      
      CONSTRAINT fk_stock
          FOREIGN KEY (id_stock)
          REFERENCES stock (id)
          ON DELETE CASCADE
  );
  CREATE TABLE discount_time_based (
      id SERIAL PRIMARY KEY NOT NULL,
      id_stock INTEGER NOT NULL,
      date_start DATE NOT NULL,
      date_end DATE NOT NULL,
      discount_percentage INTEGER NOT NULL,
      
      CONSTRAINT fk_stock
          FOREIGN KEY (id_stock)
          REFERENCES stock (id)
          ON DELETE CASCADE
  );

Backend

The backend is structured in 2 layers:

  • the first layer is composed by the REST API written in Python with the framework Flask, it is responsible to manage the requests from the frontend and answer to them with the data provided by the second layer
  • the second layer is the model composed by the repositories responsible to manage the data in the database

Frontend

The frontend is built with Node.js and the framework Svelte, it is responsible to show the data requested to the backend and to manage the user interaction with the page. Svelte is a framework that compiles the code in efficient javascript code and update in real time the data in the page when the variables change. The css classes are provided by DaisyUI and they are a wrapper of TailwindCSS classes.

How to run the tests

  • run pip install -r .\REST_API\requirements.txt
  • run python .\REST_API\app_testing.py
  • run python .\REST_API\run_all_tests.py