Skip to content

Commit 5aff2e7

Browse files
committed
update README
1 parent b9352d9 commit 5aff2e7

1 file changed

Lines changed: 51 additions & 16 deletions

File tree

README.md

Lines changed: 51 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
1-
# Zappify shoes
1+
# Zappify Shoes
22

3-
A high-end, single-product focused backend for the modern shoe enthusiast. Designed for performance, security, and scalability.
3+
## About The Project
4+
5+
**Zappify Shoes** is an online shoe store built to sell just *one* premium pair of shoes. Instead of a messy website with hundreds of products, Zappify gives the user a super clean and focused shopping experience for that single product.
6+
7+
### Simple Breakdown of What It Does:
8+
- **Beautiful Design (Frontend):** It shows off the shoe with smooth animations and a modern look so customers get a high-quality, premium feel while browsing.
9+
- **User Accounts:** Anyone can easily and safely create an account, log in, and keep their personal details secure.
10+
- **Buying Process:** It carefully handles the entire process of adding the shoe to the cart, collecting shipping details, and placing an order.
11+
- **Powerful Engine (Backend):** Behind the scenes, it uses a real database to safely store user data and orders. It's built on popular, modern technologies (React for what you see, Node.js and MongoDB for what happens behind the scenes).
12+
13+
In simple words, Zappify is a complete, real-world example of an e-commerce website designed to look great and work perfectly from start to checkout.
414

515
## Key Features
616

17+
- **Storefront UI**: Beautiful, interactive React frontend built with Vite and Framer Motion.
718
- **Authentication**: Secure user login & registration with JWT (JSON Web Tokens).
819
- **Product Management**: Clean API for managing premium shoe listings.
920
- **Order System**: Seamless order processing and shipping details.
@@ -12,53 +23,77 @@ A high-end, single-product focused backend for the modern shoe enthusiast. Desig
1223

1324
## Tech Stack
1425

26+
### Frontend
27+
- **Framework**: React (Vite)
28+
- **Styling/Animations**: CSS, Framer Motion, Lucide React
29+
30+
### Backend
1531
- **Runtime**: Node.js
1632
- **Framework**: Express.js
1733
- **Database**: MongoDB Atlas
18-
- **Security**: JWT & Bcrypt.js
34+
- **Security**: JWT, Bcrypt.js, Helmet, CORS
1935
- **CI/CD**: GitHub Actions
2036
- **Containerization**: Docker
2137

2238
## Getting Started
2339

24-
### 1. Installation
25-
Inside the backend/ folder:
40+
### 1. Backend Setup
41+
Navigate to the `backend/` folder and install dependencies:
2642
```bash
2743
cd backend
2844
npm install
2945
```
3046

31-
### 2. Configuration
32-
Create a .env file from the provided .env.example and add your database URI:
47+
Create a `.env` file from the provided `.env.example` and add your configuration:
3348
```env
3449
PORT=5001
3550
MONGO_URI=your_mongodb_uri
3651
JWT_SECRET=your_secret_key
3752
```
3853

39-
### 3. Run Locally
54+
Run the backend locally:
4055
```bash
4156
npm run dev
4257
```
4358

44-
## Docker Deployment
59+
### 2. Frontend Setup
60+
Navigate to the `frontend/` folder and install dependencies:
61+
```bash
62+
cd frontend
63+
npm install
64+
```
65+
66+
Run the frontend locally:
67+
```bash
68+
npm run dev
69+
```
70+
71+
## Docker Deployment (Backend)
4572

4673
To build and run the backend using Docker:
4774
```bash
48-
docker build -t zappify-backend ./backend
75+
cd backend
76+
docker build -t zappify-backend .
4977
docker run -p 5001:5001 zappify-backend
5078
```
5179

5280
## Repository Structure
5381
```text
5482
Zappify/
5583
├── .github/workflows/ # CI/CD Pipeline
56-
└── backend/ # Core Backend Logic
57-
├── config/ # Database configuration
58-
├── controllers/ # Route logic
59-
├── models/ # Database schemas (Mongoose)
60-
├── routes/ # API endpoints
61-
└── server.js # Main entry point
84+
├── backend/ # Core Backend Logic
85+
│ ├── config/ # Database configuration
86+
│ ├── controllers/ # Route logic
87+
│ ├── models/ # Database schemas (Mongoose)
88+
│ ├── routes/ # API endpoints
89+
│ └── server.js # Main entry point
90+
└── frontend/ # React Frontend Application
91+
├── public/ # Static assets
92+
├── src/ # Frontend source code
93+
│ ├── components/ # React components
94+
│ ├── App.jsx # Main App component
95+
│ └── index.css # Global styles
96+
└── vite.config.js # Vite configuration
6297
```
6398

6499
---

0 commit comments

Comments
 (0)