innocuous-symmetry/e-commerce
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Mikayla Dobson
2022-09-22 13:27:42 -05:00
parent 75ebb5e43d
commit 4a0ef72736
1 changed files with 3 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,17 +1,8 @@
# Mikayla's Little E-Commerce Store # Mikayla's Spice Market
A sample E-Commerce app built for a Codecademy portfolio project!
This project will be fully featured, with payment processing through Stripe, session support with Express, and a full REST API build in Express/Postgres. Thanks for checking out *Express Spices*, my from-the-ground-up e-commerce solution for buying spices! The product catalog for this store is modeled after [World Spice Merchants](https://www.worldspice.com/), sorted into categories by geographical regions.
The front end is built in React using TypeScript and Sass, and bootstrapped with Vite.
The API will be fully documented using Swagger, and available at the following link: [link] Payment information is supported through the Stripe API, with session support and user management with Express Sessions. The backend features a full REST API built in Express, connects to a PostgreSQL database, and is documented with Swagger. The app features a frontend built with React, TypeScript, and Sass.
## Project Structure
The project directory is organized as follows:
- ``client``: holds the front end details of the project
- ``db``: this hosts database logic for Node-Postgres interactions
- ``routes``: this hosts the Express router which powers the project's REST API
- ``server.js``: the backend "entryway" for the application, which hosts the server and the integration for the API.
## Installing and Running the Development Build Locally ## Installing and Running the Development Build Locally
1. Clone the project repository from the root level. 1. Clone the project repository from the root level.