Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 3 KB

README.md

File metadata and controls

49 lines (36 loc) · 3 KB
Raw

Shopify

An open source ecommerce project powered by Django as backend and React as frontend

installation

Backend

backend foundation laid on Django and RestFramework API

once after cloning package you need to make an environment to isolate the application from your gerneral python invironment. use py -m venv whatevername to make your own environment.

now it's time to install Django by using pip install django and install all its dependencies using pip install -r requirements.txt

Frontend

to get the most out of shoping API, React Js has been used, with this architecture frontend can easily adapt to whatever device we prefere to have our shop on. if you wanna stick to the original frontend provided by the project follow the few line below, otherwise jump into API guidence to save your time.

first thing first, you need to download and install node.js to provide us with npm. to install React library open your terminal and head into

project-dir/frontend and use npm install to install react and all its dependencies once for a life time.

make project working

to make the project working we need to have both Django and React open simultaniusly. for first runing django project you need to create database based on django models. use these two commands to create data schema: py manage.py makemigrations and py manage.py migrate and then, to start the django project use py manage.py runserver. now it's time to run our React project, to do so jump into the front end directory and use npm start and here we go! enjoy your hacking !!!

API

all the API interfaces in store application are provided by a core Object called Market into market.py module. this module does the CRUD operations for you by simple and chainable methods. first you need to specify what you need by it's searching methods and when your specifications finished fetch them all.

products

  • https://websitename.com/product with GET method will give all the products exist in the market
  • https://websitename.com/product with POST method will create new product
  • https://websitename.com/product/<int:product_id> with GET method will give you the product information
  • https://websitename.com/product/<int:product_id> with POST method will modify product if you are entitled to do so
  • https://websitename.com/product/find this API will get attribiutes where can modify your search result:

attributes

  • category attribiute will confide your results based on the category id you have provided in your url
  • store attribute will confide based on store_id
  • sortby will sort your search result base on what you put next to it
  • low and high will limits the search results for your pagination purpuse

all these filters can work at the same time, to undestand the concept consider this: https://websitename.com/product/find?category=2&store=3&sortby=-price&low=15&high=30 this will bring you the category that happens to have id 2, store happens to have id 3 and sore them out base on price and items 15 to 30