Overview:
The PERN Store is a full-stack e-commerce project built with Postgres, Express, React, and Node.js. It includes a Swagger API documentation, demo, and screenshots showcasing the homepage screen and database schema. The project provides guidance on running the demo locally, with instructions on installing dependencies for the server and client, starting the server and client, and running both concurrently. Additionally, deployment instructions are provided, along with information on technology used such as React, Node.js, Express, Postgres, and various libraries.
Features:
- Full-Stack E-Commerce Project: Built with Postgres, Express, React, and Node.js.
- Swagger API Documentation: Included for developers to understand and interact with the API.
- Demo and Screenshots: Provides a live demo and screenshots of the project.
- Environment Variables: Requires specific environment variables to run the project successfully.
- Deployment Guide: Offers guidance on deploying the project for production use.
- Tech Stack: Utilizes technologies like React, Node.js, Express, Postgres, and more.
- Contributing: Encourages contribution through forking, creating feature branches, and opening pull requests.
- Feedback: Directs feedback and inquiries to Joseph Odunsi for further assistance.
Installation:
To install the PERN Store theme, follow these steps:
- Clone the project:
git clone https://github.com/dhatguy/PERN-Store
- Install dependencies:
- Go to the project directory:
cd PERN-Store
- Install dependencies:
npm install
- Go to the server directory:
cd server
and install dependencies:npm install
- Go to the client directory:
cd client
and install dependencies:npm install
- Go to the project directory:
- Start the server:
- Go to the server directory:
cd server
and start the server:npm start
- Go to the server directory:
- Start the client:
- Go to the client directory:
cd client
and start the client:npm start
- Go to the client directory:
- Run both the client and server concurrently from the root directory.
For running with Docker:
- Ensure Docker is installed.
- Run the development environment or the production environment as needed.
- Access the app at http://localhost:3000.
Summary:
The PERN Store is a comprehensive full-stack e-commerce project utilizing technologies like Postgres, Express, React, and Node.js. It offers a Swagger API documentation, demo, and guidance on installation and deployment. By following the provided instructions, developers can explore the features, contribute to the project, and deploy it for production use. The project emphasizes collaboration through forking, feature branches, and pull requests, with feedback directed to the project maintainer for further engagement.