aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorLibravatarLibravatar Biswa Kalyan Bhuyan <[email protected]> 2025-05-28 15:06:59 +0530
committerLibravatarLibravatar Biswa Kalyan Bhuyan <[email protected]> 2025-05-28 15:06:59 +0530
commita92719db37afc5cdf375f3ad5ce8e9602450ab2d (patch)
tree783530b755b1fe1c1b1981ad8d6230e662cf0a64 /README.md
downloadblcklst-a92719db37afc5cdf375f3ad5ce8e9602450ab2d.tar.gz
blcklst-a92719db37afc5cdf375f3ad5ce8e9602450ab2d.tar.bz2
blcklst-a92719db37afc5cdf375f3ad5ce8e9602450ab2d.zip
feat: added the docs page
Diffstat (limited to 'README.md')
-rw-r--r--README.md87
1 files changed, 87 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4feb096
--- /dev/null
+++ b/README.md
@@ -0,0 +1,87 @@
+# E-Commerce Clothing Brand Website
+
+A modern e-commerce platform for a clothing brand similar to turntupfashion.com, built with Next.js, Express, and MongoDB.
+
+## Project Overview
+
+This project provides a complete e-commerce solution with the following features:
+- Responsive product catalog with filtering and search
+- User authentication and account management
+- Shopping cart and checkout process
+- Payment processing integration
+- Admin dashboard for product and order management
+- Multi-currency support
+
+## Tech Stack
+
+- **Frontend**: Next.js, React, Tailwind CSS
+- **Backend**: Node.js, Express.js
+- **Database**: MongoDB with Mongoose
+- **Authentication**: JWT
+- **Payment**: Stripe API
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js (v16+)
+- MongoDB
+- Stripe account for payment processing
+
+### Installation
+
+1. Clone the repository
+```bash
+git clone https://github.com/yourusername/ecom.git
+cd ecom
+```
+
+2. Set up the frontend
+```bash
+cd frontend
+npm install
+cp .env.example .env.local
+# Edit .env.local with your environment variables
+```
+
+3. Set up the backend
+```bash
+cd ../backend
+npm install
+cp .env.example .env
+# Edit .env with your environment variables
+```
+
+4. Start development servers
+
+Frontend:
+```bash
+cd frontend
+npm run dev
+```
+
+Backend:
+```bash
+cd backend
+npm run dev
+```
+
+## Project Structure
+
+The project follows a clear separation between frontend and backend:
+
+- `/frontend`: Next.js application with pages, components, and assets
+- `/backend`: Express.js API with controllers, models, and routes
+- `/admin`: Admin dashboard (optional separate application)
+- `/shared`: Shared code and types between frontend and backend
+
+## Documentation
+
+For more detailed documentation, see:
+- [Project Plan](./docs/project-plan.md) - Complete project overview and timeline
+- [Implementation Guide](./docs/implementation.md) - Step-by-step implementation details
+- [Component Structure](./docs/components.md) - Frontend component organization
+
+## License
+
+MIT