An open API service indexing awesome lists of open source software.

https://github.com/deepakkumar55/bseb-study-campanion


https://github.com/deepakkumar55/bseb-study-campanion

Last synced: 10 months ago
JSON representation

Awesome Lists containing this project

README

          

![MIT License](https://img.shields.io/badge/license-MIT-green)
![Contributors](https://img.shields.io/github/contributors/your-org/your-repo)
![Forks](https://img.shields.io/github/forks/deepakkumar55/bseb-study-campanion)
![Stars](https://img.shields.io/github/stars/deepakkumar55/bseb-study-campanion)
![Issues](https://img.shields.io/github/issues/deepakkumar55/bseb-study-campanion)
![Pull Requests](https://img.shields.io/github/issues-pr/deepakkumar55/bseb-study-campanion)
![Last Commit](https://img.shields.io/github/last-commit/deepakkumar55/bseb-study-campanion)

# ๐Ÿ“˜ BSEB Study Companion โ€“ Class 12 (by TheCampusCoders)

**BSEB Study Companion** is a free, open-source learning platform built by [TheCampusCoders](https://twitter.com/thecampuscoders), tailored for **Bihar Board Class 12** students.
It provides a modern and structured approach to exam prep, featuring:

- โœ… Previous Year Papers & Detailed Solutions
- โœ… Chapter-wise Tests & Smart Quizzes
- โœ… Handwritten & Digital Notes
- โœ… Personalized Dashboard for Progress Tracking

> Built with **Next.js**, styled using **Tailwind CSS**, deployed on **Vercel**, and powered by **MongoDB**.

---

## ๐Ÿš€ Features

### ๐Ÿ“„ Previous Year Papers
- Subject-wise papers with download option
- Year-wise filtering
- Includes solutions

### ๐Ÿงช Chapter-wise Tests
- Auto-generated tests for each chapter
- Track performance and retry for improvement

### ๐ŸŽฏ MCQ Quizzes
- Exam-pattern MCQs
- Instant result + correct answer explanation

### ๐Ÿ“ Notes Section
- Handwritten & typed notes
- Organized by subject โ†’ chapter โ†’ topic

### ๐Ÿ‘ค User Dashboard
- Save bookmarks, test scores, quiz history
- JWT-based authentication

---

## ๐Ÿง‘โ€๐Ÿ’ป Tech Stack

| Category | Technology |
|--------------|------------------------|
| Frontend | Next.js (App Router) |
| Styling | Tailwind CSS |
| Backend API | Next.js API Routes |
| Database | MongoDB + Mongoose |
| Auth | JWT + bcrypt.js |
| File Upload | Cloudinary + Multer |
| Hosting | Vercel |

---

## ๐Ÿ›  Getting Started

### 1. Clone the repository

```bash
git clone https://github.com/deepakkumar55/bseb-study-campanion.git
cd bseb-study-companion
````

### 2. Install dependencies

```bash
npm install
```

### 3. Configure environment variables

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

```env
MONGODB_URI=your_mongodb_connection
JWT_SECRET=your_jwt_secret
```

### 4. Start the development server

```bash
npm run dev
```

Visit `http://localhost:3000` in your browser.

---

## ๐ŸŒ Deployment (Vercel)

To deploy your own version on [Vercel](https://vercel.com):

1. Push the code to GitHub
2. Import the repo on Vercel
3. Add environment variables in the Vercel dashboard
4. Deploy with one click โœ…

---

## ๐Ÿค Contributing
> Please refer to [`CONTRIBUTING.md`](CONTRIBUTING.md) for detailed contribution guidelines.

---

## ๐Ÿ‘จโ€๐Ÿ’ป Contributors

Thanks to these amazing people for making this project better!
Want to join the list? [Start here โ†’](https://github.com/deepakkumar55/bseb-study-campanion/graphs/contributors)



Deepak Kumar

๐Ÿ’ป Project Owner

---

## ๐Ÿ“œ License

This project is licensed under the **MIT License**.
You're free to use, modify, and distribute it with attribution.

---

## ๐Ÿ“ฌ Contact

* Twitter: [@thecampuscoders](https://twitter.com/thecampuscoders)
* Instagram: [@campus\_store\_official](https://instagram.com/thecampuscoders)
* Email: [support@thecampuscoders.com](mailto:support@thecampuscoders.com)

---

> ๐Ÿง  **"Digital Saathi for every BSEB student."**
> Made with โค๏ธ by [The Campus Coders](https://thecampuscoders.com)