Skip to content

Latest commit

 

History

History
149 lines (92 loc) · 4.32 KB

README.md

File metadata and controls

149 lines (92 loc) · 4.32 KB
Raw

App Preview

App Preview

nextdotjs zod postgresql drizzle tailwindcss shadcn

E-Commerce App

Deployed Live Website

Authenticating

To authenticate as ADMIN and view the /admin/overview route, you can use the following credentials:

Email:

[email protected]

Password:

123456

📋 Table of Contents

  1. 🛒 Introduction
  2. ⚙️ Tech Stack
  3. 🔋 Features
  4. 🚀 Quick Start

🛒 Introduction

This E-commerce app is built with Next.js and PostgreSQL, using Drizzle ORM for database interactions. It offers a seamless shopping experience with features like product listings, shopping cart management, user authentication, and order processing.

⚙️ Tech Stack

  • Next.js
  • Zod
  • PostgreSQL
  • Drizzle ORM
  • Tailwind CSS
  • Shadcn

🔋 Features

👉 User Authentication: Secure login and registration using social sign-on or traditional email and password methods.

👉 Product Listings: Browse through a variety of products, view detailed descriptions, and add items to the shopping cart.

👉 Shopping Cart: Manage your shopping cart, update quantities, and remove items before proceeding to checkout.

👉 Order Processing: Seamlessly process orders, including payment integration and order confirmation.

👉 Admin Dashboard: Admins can manage products, view orders, and handle customer queries through an intuitive dashboard.

👉 Responsive Design: Ensures optimal user experience across devices with a responsive and adaptive design.

👉 Secure and Scalable: Built with best practices for security and scalability in mind, ensuring data integrity and privacy.

and many more, including advanced search and filtering options.

🚀 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

Cloning the Repository

git clone https://github.com/Agamya-Samuel/Ecommerce-NextJS
cd Ecommerce-NextJS

Installation

Install the project dependencies using pnpm:

pnpm install

Set Up Environment Variables

Create a new file named .env in the root of your project and add the following content:

NEXTAUTH_SECRET=YOUR_SECRET

POSTGRES_URL=postgresql://user:password@localhost:5432/database

NEXT_PUBLIC_APP_NAME=YOUR_APP_NAME
NEXT_PUBLIC_APP_DESCRIPTION=YOUR_APP_DESCRIPTION

# Add other necessary environment variables

Replace the placeholder values with your actual PostgreSQL credentials and other necessary configuration.

Running the Project

pnpm run dev

Open http://localhost:3000 in your browser to view the project.

Building for Production

pnpm run build
pnpm start

This will start the production server.

Contributing

If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Feel free to customize any section further based on the specific details of your project.