Skip to content

Latest commit

 

History

History
282 lines (180 loc) · 8.75 KB

README.md

File metadata and controls

282 lines (180 loc) · 8.75 KB
Raw

logo

E-Commerce Admin

Welcome to ADMIN, your ultimate store management solution! Easily handle multiple stores with features like Overview Charts 📊, Billboards 🏞️, Categories 📦, Products 🛒, and Orders 📋 management with store Settings ⚙️, and more. Our sleek UI offers light/dark modes and Clerk authentication for security 🔐. We use Prisma ORM for efficient database management and Next Cloudinary for image uploads 🖼️. Products are automatically archived upon purchase 💰, and you can feature them on your homepage with a simple click. So, why wait? Dive into ADMIN and take control of your stores like never before!



📜 Table of Contents



🚀 Live Demo

Immerse yourself in its design and functionality with an interactive live demo — simply click the link to explore.

Live Preview ➡️ Demo



🖼️ Project Screenshots

Feel free to check out the screenshots of my website for a sneak peek into its captivating user interface.


⬅️ Overview ➡️

screenshot


⬅️ Billboards ➡️

screenshot


⬅️ Categories ➡️

screenshot


⬅️ Sizes ➡️

screenshot


⬅️ Colors ➡️

screenshot


⬅️ Products ➡️

screenshot


⬅️ Orders ➡️

screenshot


⬅️ Settings ➡️

screenshot


⬅️ Create Store ➡️

screenshot



💡 Key Features

Here are some of the standout features of the project:

  • Overview Charts 📊: Gain insights into your store's performance with detailed charts and analytics.

  • Billboards 🏞️: Showcase your products and promotions with eye-catching billboards on your store's homepage.

  • Categories 🗂️: Organize your products into categories for easy navigation and better user experience.

  • Products 🛍️: Add, edit, and manage your product catalog effortlessly.

  • Orders 📦: Streamline order processing and keep track of customer purchases.

  • Store Settings ⚙️: Customize your store's settings to meet your specific requirements.

  • Light/Dark Modes 🌗: Enjoy a sleek and customizable user interface with light and dark modes.

  • Clerk Authentication 🔐: Ensure the security of your store with robust Clerk authentication.

  • Prisma ORM 📚: Utilize Prisma ORM for efficient and reliable database management.

  • Next Cloudinary Integration 🖼️: Seamlessly upload and manage images for your products using Next Cloudinary.

  • Automatic Product Archiving 🗃️: Products are automatically archived upon purchase to keep your catalog up to date.

  • Featured Products ⭐: Easily feature products on your homepage with a simple click to boost sales.

Take control of your stores like never before with ADMIN! Get started today and revolutionize your store management experience.



🛠️ Installation & Set Up

1. Clone the repository:

git clone https://github.com/kranthikumarkaranam/e-commerce_admin.git

2. Go to the project directory:

cd e-commerce_admin

3. Install dependencies using npm:

npm install

4. Applying Database Schema Changes with Prisma:

Before running this command, ensure you have set up Prisma using npx prisma generate.

npx prisma db push

5. Start the development server:

Before starting the server add these env variables.

npm run dev


🏭 Building & Running for Production

1. Generate a full static production build:

npm run build

2. Preview the site as it will appear once deployed:

npm run start


🌱 Environment Variables

To run this project, you need to add the following environment variables to your .env file in the project's root directory.

Also, feel free to take a look at the .env.example file here.

  • NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY
  • CLERK_SECRET_KEY
  • NEXT_PUBLIC_CLERK_SIGN_IN_URL
  • NEXT_PUBLIC_CLERK_SIGN_UP_URL
  • NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL
  • NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL
  • DATABASE_URL
  • NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME
  • STRIPE_API_KEY
  • STRIPE_WEBHOOK_SECRET
  • FRONTEND_STORE_URL


💻 Tech Stack

Technologies used in the project:

  • React.js
  • NEXT.js
  • TypeScript
  • Tailwind CSS
  • zod
  • react-hot-toast
  • shadcn/ui
  • Radix UI
  • Lucide React
  • Next Cloudinary
  • Clerk
  • React Hook Form
  • Prisma ORM
  • Prisma Client
  • React Table
  • TanStack Table
  • date-fns
  • react-spinners
  • Recharts
  • Stripe
  • axios
  • zustand


🍰 Contribution Guidelines

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  • See Contributing for ways to get started.
  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request by following the guidelines here.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.
  • Also, please read through the Code of Conduct before posting your first idea as well.


📝 Creating a Pull Request

Follow the steps below to Initiate a Pull Request

  1. Fork the repository
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request


💖 Like my work?

Thank you for taking the time to explore the project. I hope it brings value and joy to those who use it.

If you require any help or have any questions, please don't hesitate to reach out to me here.




Made with ❤️ by KRANTHI.