Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mayankghatawal/book-world
Book World in MERN Stack
https://github.com/mayankghatawal/book-world
expressjs figma mern-stack mongodb nodejs reactjs
Last synced: 3 days ago
JSON representation
Book World in MERN Stack
- Host: GitHub
- URL: https://github.com/mayankghatawal/book-world
- Owner: MayankGhatawal
- Created: 2024-11-22T06:10:06.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-12-10T08:29:58.000Z (about 2 months ago)
- Last Synced: 2024-12-10T09:27:42.431Z (about 2 months ago)
- Topics: expressjs, figma, mern-stack, mongodb, nodejs, reactjs
- Language: JavaScript
- Homepage: https://book-world-complete.vercel.app/
- Size: 2.39 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🌟 **Book World**
A full-featured book review and management application built using the **MERN stack**.
Users can explore books, leave reviews with star ratings, and manage their favorites. Admins enjoy extended features to manage books, users, and access controls.
---
## ✨ **Features**
### 🔒 **User Authentication**
- Secure user registration and login.
- **JWT** for token-based authorization.
- **Bcrypt** for password hashing.
### 📚 **Book Listing with Reviews**
- Browse and search for books effortlessly.
- Leave detailed reviews with star ratings.
- Gain insights through community feedback.
### 👤 **User Profiles**
- Personalized dashboards to track activity.
- Curate and manage a list of favorite books.
### 💬 **Advanced Nested Commenting**
- Efficient comment deletion using **DFS** within review threads.
### ⚡ **Admin Features**
- Role-based access control.
- Manage books: Add, edit, or delete listings.
- Oversee user data and roles (excluding a master admin).
---
## 🛠 **Technologies Used**
### Frontend
- **React.js**
- **Recoil** for state management
- **Tailwind CSS** for styling
- **ShadCN UI** for elegant components
- **React Hook Form** for form handling
- **TanStack Tables** for data display
- **Lucide-React** for icons
### Backend
- **Node.js** + **Express.js**
- **MongoDB** with **Mongoose**
- **JWT** for authentication
- **Multer** for file uploads
- **CORS** for API accessibility
- **Bcrypt** for secure password storage
### Additional Dependencies
- **Axios** for HTTP requests
- **Zod** for schema validation
- **React Router DOM** for routing
- **Cloudinary** (optional) for image uploads
---
## ⚙️ **Installation Guide**
### Prerequisites
- **Node.js**
- **MongoDB** (local or **Mongo Atlas URL**)
### 🔑 **Environment Variables**
1. Rename `.env.example` to `.env` in both `backend` and `frontend` directories.
2. Add the following keys:
- `MONGO_URL`
- `JWT_SECRET`
- `CLOUD_NAME`
- `CLOUD_API_KEY`
- `CLOUD_API_SECRET`
- `PORT`
> **Note:** If not using Cloudinary, update `/backend/middleware/upload.js` to use `diskStorage`.
---
### 🚀 **Steps to Run the Project**
#### 1️⃣ Clone the Repository
```bash
git clone https://github.com/MayankGhatawal/Book-World.git
cd book-world
```
#### 2️⃣ Install Dependencies
```bash
# Backend
cd backend
npm install
# Frontend
cd ../frontend
npm install
```
#### 3️⃣ Start the Application
```bash
# Frontend (from frontend directory)
npm run dev
# Backend (from backend directory)
node index.js
```
#### 4️⃣ Access the Application
- Open your browser and visit: **[localhost:5173](http://localhost:5173)**
---
## 🙌 **Contributing**
Contributions are welcome! Here's how you can get involved:
1. Fork the repository.
2. Create a new branch.
3. Make your changes and commit them.
4. Submit a pull request.
---
## 📧 **Contact**
For questions or support, feel free to reach out!
- **GitHub:** [MayankGhatawal](https://github.com/MayankGhatawal)
---
Make sure to enhance this further with real screenshots or visuals for added appeal.