Skip to content

jenplanque/ecommerce_API

Repository files navigation

E-Commerce App

Table of Contents

Introduction

This E-Commerce App is a web application created for my Module 3 project at Coding Temple. It was designed to facilitate the online shopping experience at a coffee shop, and is loosely based on the 1990's - early 2000's sitcom, FRIENDS.

The app allows you to add, modify and delete users, orders and products (inventory), as well as add products to individual orders and run various "reporting" (GET) requests to return the content of the various tables included in the database.

The app is built using Flask, SQLAlchemy, and Marshmallow for the backend, and it connects to a MySQL database.

Features

  • Users: add, modify, delete
  • Orders: add, modify, delete
  • Products: add, modify, delete
  • Add/Remove products from orders
  • "Reporting" (GET requests) for all DB tables

Installation

To install and run the E-Commerce App locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/jenplanque/ecommerce_API.git
    cd ecommerce_API
  2. Create and activate a virtual environment:

    python3 -m venv venv
    source venv/bin/activate
  3. Install the required dependencies:

    pip install -r requirements.txt
  4. Set up the database:

    flask db init
    flask db migrate
    flask db upgrade
  5. Run the application:

    flask run

Prerequisites

  • Python 3.9 or higher
  • MySQL database
  • Flask
  • SQLAlchemy
  • Marshmallow

Usage

  1. Start the Flask development server:

    flask run
  2. Open your web browser and navigate to http://localhost:5000.

  3. Use the provided endpoints to interact with the application (e.g., register a new user, add products, place orders).

Authors

Collaborators

A big shout out to some of my very favorite people at Coding Temple, without who's ongoing support this project wouldn't be possible:

API Screenshots

Home Page: Home Page

GET All Users: User Requests

GET All Orders: Order Requests

GET All Products: Product Requests

About

e-commerce API built using Flask, SQLAlchemy, Marshmallow and Postman

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages