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

readme, changes to api structure

Browse Source
This commit is contained in:
Mikayla Dobson
2022-10-02 10:13:31 -05:00
parent 7b3063f43b
commit 6873bab352
8 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -2,7 +2,7 @@
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.
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.
Payment information will be supported through the Stripe API, with session support and user management with Express Sessions. The backend features a full REST API built in Express, which connects to a PostgreSQL database, hosted with [Supabase](app.supabase.com). [Documentation for the API](https://mikayla-spice-market-api.herokuapp.com/api-docs) is provided with Swagger. The app features a frontend built with React, TypeScript, and Sass.
## Installing and Running the Development Build Locally
1. Clone the project repository from the root level.
@@ -11,4 +11,8 @@ Payment information is supported through the Stripe API, with session support an
4. Change into the ``/client`` directory and run ``npm install`` to install frontend dependencies.
5. Still within ``/client``, run ``npm run dev`` to start the Vite development server.
6. In another terminal window at the root directory level, run ``npm start`` to start the localhost server.
7. It should indicate that the server is listening on its designated port, and log each database transaction to the console.
7. It should indicate that the server is listening on its designated port, and log each database transaction to the console.
## Accessing the Project and its REST API Online
1. The REST API for this project is exposed at https://mikayla-spice-market-api.herokuapp.com/
2. The client site will be hosted on Netlify and is not online as of yet.