CodeCrafters E-Commerce

Welcome to CodeCrafters E-Commerce, a robust and user-friendly platform for buying and selling products online. This repository contains the codebase for our e-commerce website, including the front-end, back-end, and database configurations.

Table of Contents

• Features
• Installation
• Usage
• Technologies Used
• Contributing

Features

• User Authentication: Secure user login and registration.
• Product Management: Add, edit, and delete products.
• Shopping Cart: Add products to the cart and manage quantities.
• Checkout Process: Seamless checkout with payment integration.
• Order Management: Track and manage orders.

Installation

Prerequisites

• Node.js
• npm
• postgresql

Steps

1. Clone the repository:

   git clone https://github.com/csec-dev-web-bootcamp/codeCrafters-e-commerce.git
   cd codeCrafters-e-commerce

2. Install dependencies:

   npm install

3. Set up environment variables:

   Create a .env file in the root directory and add the following:

    NODE_ENV=development
    PORT=5000
    DATABASE_URL=postgresql://username:password@localhost:5432/your-database-name
    JWT_SECRET=your_jwt_secret
   

4. Run the application:

   npm start

5. Open the application in your browser:

   http://localhost:5000

Usage

Adding Products

1. Log in as an admin user.
2. Navigate to the admin dashboard.
3. Add, edit, or delete products from the products section.

Shopping

1. Browse products and add desired items to the shopping cart.
2. Proceed to checkout to place an order.
3. Track your orders in the orders section of your account.

Technologies Used

• Front-End: Nextjs, Zustand, Tailwind, JavaScript, shadcn UI
• Back-End: Node.js, Express.js
• Database: postgresql
• Authentication: JSON Web Tokens (JWT)
• Payment Gateway: Chapa

Contributing

We welcome contributions from the community! To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.

Please ensure your code follows our coding guidelines and includes relevant tests.