Butcher

Butcher is an online butcher shop application built with React, TypeScript, and Vite for the frontend, and Express and MongoDB for the backend. The application allows users to browse products, add them to the cart, and place orders. Admins can manage product prices and view orders.

Table of Contents

• Features
• Installation
• Usage
• Project Structure
• Technologies Used
• Contributing
• License

Features

• Browse products (Chicken, Mutton, Eggs)
• Add products to the cart
• Update product quantities in the cart
• Place orders
• Admin panel to manage product prices and view orders

Installation

Prerequisites

• Node.js (v14 or higher)
• npm or yarn
• MongoDB

Backend Setup

1. Navigate to the backend directory:

cd backend

2. Install dependencies:

npm install

3. create a .env file in the backend directory and ad your MongoDB connection string:

DB=<your-mongodb-connection-string>
PORT=5000

4. start the backend server:

npm run dev

Admin And Client Frontend Setup

1. Navigate to the admin/client directory:

cd admin 
# or
cd client

2. Install dependencies:

npm install

3. start development server:

npm run dev

Usage

1. Open your browser and navigate to http://localhost:5173 for client frontend.

2. Open your browser and navigate to http://localhost:5174 for admin frontend.

3. The backend server will be running on http://localhost:3000

Project Structure

.
├── admin
│ ├── .gitignore
│ ├── components.json
│ ├── eslint.config.js
│ ├── index.html
│ ├── package.json
│ ├── postcss.config.js
│ ├── public
│ ├── README.md
│ ├── src
│ ├── tailwind.config.js
│ ├── tsconfig.app.json
│ ├── tsconfig.json
│ ├── tsconfig.node.json
│ └── vite.config.ts
├── backend
│ ├── .env
│ ├── controllers
│ ├── database
│ ├── functions
│ ├── middleware
│ ├── modals
│ ├── package.json
│ ├── routes
├── client
│ ├── .env
│ ├── .gitignore
│ ├── components.json
│ ├── eslint.config.js
│ ├── index.html
│ ├── package.json
│ ├── postcss.config.js
│ ├── public
│ ├── README.md
│ ├── src
│ ├── tailwind.config.js
│ ├── tsconfig.app.json
│ ├── tsconfig.json
│ ├── tsconfig.node.json
│ └── vite.config.ts
├── .gitignore
└── README.md

Technologies Used

• Frontend:
  • React
  • Typescript
  • vite
  • Tailwind CSS
  • Axios
• Backend:
  • Express
  • MongoDB
  • Mongoose
  • dotenv

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes

License

This project is licensed under the MIT License.