Git Product home page Git Product logo

ecom-apis's Introduction

Ecommerce API's

REST API's for an e-commerce marketplace.


Requirements

For development, you will need Node.js, Postgres and a node global package, Yarn, installed in your environement.

Postgres Db Setup

  • Create a postgres database and store the credentials somewhere.
  • Copy contents of scripts/create-table.sql and run the queries on postgres server to create the tables.

Yarn installation

After installing node, this project will need yarn too, so just run the following command.

  $ npm install -g yarn

Install

$ git clone https://github.com/aman2457/ecom-apis.git
$ cd ecom-apis
$ yarn install

Configure app

  • Create .env file in root of your repository
  • Check .env.example file and set the variables accordingly.
  • TOKEN_SECRET_KEY is a sign key to generate jsob web token, copy the 63 random alpha-numeric characters (a-z, A-Z, 0-9) value from this website and set the TOKEN_SECRET_KEY value.

Running the project

  • If all the above steps are completed then we can run this project using yarn start to run the server yarn watch to run the server in watch mode
  • After running the server you can go to scripts/Ecom APis.postman_collection.json to access postman collections of endpoints.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.