PrepNerdz 📚

The ultimate academic resource platform for BTECH students - where finding study materials stops being a struggle!

Explore the Project Internals »

📊 Project Insights

🌟 Stars	🍴 Forks	🐛 Issues	🔔 Open PRs	🔕 Closed PRs	🛠️ Languages	👥 Contributors

Welcome! This is the central hub for Prepnerdz. For a deep dive into the project's architecture, setup, and contribution guidelines, please see our dedicated documentation:

• 📖 LEARN.md: Understand the project structure, database schema, and API.
• 🤝 CONTRIBUTING.md: Our main guide for contributors, with detailed setup and development instructions.
• 📜 CODE_OF_CONDUCT.md: Our community standards.

Report Bug · Request Feature

🌟 Features

• Centralized Resources: Previous year papers (RGPV), Best notes, lab manuals etc.., all in one place
• Verified Content: Faculty and topper-approved materials
• Bookmarking: Save important resources for quick access
• Contribution System: Earn recognition for contributing useful content

🎯 Open Source Programs ⭐

This project is now OFFICIALLY accepted for:

🌟 Exciting News...

🚀 This project is now an official part of GirlScript Summer of Code – GSSoC'25! 💃🎉💻 We're thrilled to welcome contributors from all over India and beyond to collaborate, build, and grow prepnerdz! Let’s make learning and career development smarter – together! 🌟👨‍💻👩‍💻

👩‍💻 GSSoC is one of India’s largest 3-month-long open-source programs that encourages developers of all levels to contribute to real-world projects 🌍 while learning, collaborating, and growing together. 🌱

🌈 With mentorship, community support, and collaborative coding, it's the perfect platform for developers to:

• ✨ Improve their skills
• 🤝 Contribute to impactful projects
• 🏆 Get recognized for their work
• 📜 Receive certificates and swag!

🎉 I can’t wait to welcome new contributors from GSSoC 2025 to this prepnerdz project family! Let's build, learn, and grow together — one commit at a time. 🔥👨‍💻👩‍💻

🛠 Tech Stack

Frontend	Backend	Database
Next.js (TS)	Node.js	PostgreSQL
Tailwind CSS	Express.js	Prisma ORM

🚀 Getting Started locally on your machine!

Prerequisites

• Node.js (v18+)
• PostgreSQL (v15+)
• Google Cloud account (for Drive API)
• Cloudinary APIs (for avatar/image uploads)

Installation

1. Clone the repository

   git clone https://github.com/Shubhashish-Chakraborty/prepnerdz.git
   cd prepnerdz

2. Install dependencies

   npm install

   PrepNerdz Frontend: /apps/web
   Backend : /apps/backend
   Admin Panel: /apps/admin

3. Set up environment variables

   Create a .env file in the respective directories:

   • For frontend : ENV SAMPLE
   • For Backend : ENV SAMPLE
   • For Admin : ENV SAMPLE

4. Run the application

   • In the Root directory, run the following command:

     npm run dev

   • If you want to run Individual apps:
     • In the Frontend directory, run: npm run dev
     • In the Backend directory, run: npm run dev
     • In the Admin directory, run: npm run dev

🤝 How to Contribute

We welcome contributions from the community! Please see our comprehensive Contributing Guide for detailed instructions.

Quick Summary:

1. Fork the repository & clone your forked repository.
2. Submit an issue or feature request.
3. Create a new & separate branch for your feature or bug fix.
4. Make your changes.
5. Commit your changes with a clear and descriptive commit message.
6. Push your changes to your forked repository.
7. Create a pull request to the main repository.
8. Wait for your pull request to be reviewed and merged.
9. Your contribution is now part of PrepNerdz!

Finally you'll get a shoutout on LinkedIn and X (Twitter)!

🤝👤 Contribution Guidelines

We love our contributors! If you'd like to help, please check out our CONTRIBUTE.md file for guidelines.

Thank you once again to all our contributors who have contributed to prepnerdz! Your efforts are truly appreciated. 💖👏

See the full list of contributors and their contributions on the GitHub Contributors Graph.

Show some by starring this awesome repository!

💡 Suggestions & Feedback

Feel free to open issues or discussions if you have any feedback, feature suggestions, or want to collaborate!

🙌 Support & Star

If you find this project helpful, please give it a star ⭐ to support more such educational initiatives!

📄 License

This project is licensed under the MIT License - see the License file for details.

🧑‍💻Project Admin & Maintainer:

Shubhashish-Chakraborty

Give us a Star and let's make magic!

👨‍💻 Built with ❤️ by the prepnerdz Team

❤️ Shubhashish-Chakraborty and Contributors ❤️ open an issue | Watch Demo

Ready to show off your coding achievements? Get started with prepnerdz today! 🚀