node-product-variation-sku

Express WebApplication for filtering procuts and its variation

for example coffee pods with properties like type,flavor, size, etc...

• Product Variation Sql Architecture for product variants
• Filter API for getting product by its variation
• routes are dine via express-routes-mapper
• linting via eslint
• integration tests running with Jest

Table of Contents

• Install & Use
• Folder Structure
• DataBase Structure

Install and Use

Start by cloning this repository

# HTTPS
$ git clone https://github.com/abdolrhman/node-product-variation-sku

then

# cd into project root
$ npm i
# to use mysql
$ npm i mysql2 -S
$ npm install
# start the api
$ npm start

route : localhost:8000/public/skulist    
request type: "GET"

ex : localhost:8000/public/skulist?productname=Coffee pods&variant=small

Implementation Objective :-

• Build Archticture for SKU As for any product, in which it can be quired by some variation (size, type, ...)
• Seed Database for some SKU, with full cycle
• The Cycle of databse archticture is :
  • Adding Productin products table
  • Adding Variant name ex: Color, Material, type, etc ...
  • Adding Variant Value : ex: (color, red) , (color, blue), (type, base) , (type, premium) etc ..
  • Add Product Variant this will hold the (product id, sku)
  • Add Product Denials this will hold (product-variant-id, variant-value-id)
  • Mainly for most of the SKT queries it will be around this 3 tables (productVariant, ProductDetails, variantValue)
  • the rest of tables is for some other queries .

Folder Structure

the project has 4 main directories:

• api - for controllers, models, services, etc.
• config - for routes, database, etc.
• db - this is only a dir for the sqlite db, the default for NODE_ENV development
• test - using Jest

Test

All test uses Jest and supertest for integration testing.

Database Structure

CREATE TABLE products 
    (
     product_id int auto_increment primary key, 
     name varchar(20), 
     description varchar(30)

    );

INSERT INTO products
(name)
VALUES
('coffe' ),
('pod');

create table variants (variant_id int auto_increment primary key,
                       variant varchar(50)
                       );
insert into variants (variant)
values ('color'),('material'),('size') ;   
create table variant_value(value_id int auto_increment primary key, 
                           variant_id int ,
                           value varchar(50)
                           );

insert into variant_value (variant_id,value)
values (1 ,'red'),(1 ,'blue'),(1 ,'green'),
        (2 ,'wool'),(2 ,'polyester'),
        (3 ,'small'),(3 ,'medium'),(3 ,'large');



create table product_Variants( product_Variants_id int  auto_increment primary key,
                            product_id int,
                            productVariantName varchar(50),
                            sku varchar(50),
                            price float
                            );




create table product_details(product_detail_id int auto_increment primary key,
                             product_Variants_id int,

                             value_id int
                             );

insert into product_Variants(product_id,productVariantName,sku,price)
values (1,'red-wool' ,'a121',50);

insert into product_details(product_Variants_id , value_id)
values( 1,1),(1,4);

insert into product_Variants(product_id,productVariantName,sku,price)
values (1,'red-polyester' ,'a122',50);

insert into product_details(product_Variants_id , value_id)
values( 2,1),(2,5);

Controller

Note: those request are asynchronous, we use async await syntax.

Converge Auth

Models

Are usually automatically tested in the integration tests as the Controller uses the Models.

npm start

• runs nodemon watch task for the all files conected to .api/api.js
• sets the environment variable NODE_ENV to development
• opens the db connection for development
• starts the server on 127.0.0.1:8000

npm test

This command:

• runs npm run lint (eslint) with the airbnb styleguide without arrow-parens rule for better readability
• sets the environment variable NODE_ENV to testing
• creates the database.sqlite for the test
• runs jest --coverage for testing with Jest and the coverage
• drops the database.sqlite after the test

Implementation

made for swenson-he. Task assessment