GithubHelp home page GithubHelp logo

ecommerce-api's Introduction

TSHIRTSHOP API

CircleCI

An API for a tshirt online store

features

  • Users can see all items when entering the website.
  • Items are displayed properly based on the selected department and category.
  • Users can search items through search box.
  • Support paging if we have too many items.
  • Users can see item details by selecting a specific item.
  • Users can add items to their shopping carts.
  • Users can register/login using website custom forms, or social login libraries.
  • Users can checkout with 3rd party payment gateways: Paypal or Stripe.
  • Users will get confirmations over emails about their orders.

Root Endpoint

[https://protected-mesa-94426.herokuapp.com]

API Documentation

API documenntation: [https://documenter.getpostman.com/view/6573134/S1LyV85N]

Getting started

Prerequisites

In order to install and run this project locally, you would need to have the following installed on you local machine.

Installation

  • Clone this repository
git clone [https://github.com/tonyguesswho/Ecommerce-api.git]
  • Navigate to the project directory

  • Run npm install or yarn to instal the projects dependencies

  • create a .env file and copy the contents of the .env.sample file into it and supply the values for each variable

cp .evn.sample .env
  • Create a MySQL database and run the sql file in the models directory to migrate the database

Stripe Integration

Shopping orders are paid for using a Stripe integration. In order to use the stripe endpoint send a POST request to /stripe/charge

You will need to provide a stripeToken. To get the token fill out the form at https://ecommerce-turing-core.herokuapp.com/stripe

Project structure

ecommerce-api's People

Contributors

tonyguesswho avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

ecommerce-api's Issues

Creating order issue

when you create new order the cart must be empty after a successful order, which doesn't happen.
I think you should consider this case

env file

.env.sample file is missing in source code.

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.