Skip to content

swymbnsl/EZCrack

Repository files navigation

EZCrack logo

EZCrack

NextJs TypeScript MongoDB TailwindCSS code style: prettier GitHub repo size

20% Effort, 80% Results

View Demo . Report Bug . Request Feature

Table Of Contents

About The Project

EZCrack Home Page

EZCrack is a one-stop platform for IPU students to get instant access to:

  • Weightage-wise topic breakdown
  • Most repeated questions (concept-based and pattern-based)
  • Accurate, curriculum-aligned notes
  • Crisp formula sheets
  • Topic-wise & year-wise PYQs

Why EZCrack?

When I joined MAIT, I realized that IPU exams mainly consist of repeated PYQs, but there was no way of knowing which PYQs are repeated, which topics are asked frequently, and which topics can be skipped.

There was only one way: a one-stop platform with smart analysis of all PYQs. And that's exactly what EZCrack does. EZCrack analyzes PYQs and tells you the bare minimum you need to study to score the maximum marks.

Not just this, it provides formula sheets and topic-wise notes so that users can study topics selectively. Hence the tagline: 20% Effort, 80% Results.

Features

✨ Smart Organization

  • Branch-wise and semester-wise categorization
  • Subject and unit-based navigation
  • Topic-wise question filtering

πŸ“Š Advanced Analytics

  • Weightage calculation for each topic
  • Question frequency analysis
  • Year-wise question distribution
  • Repeated question patterns (concept & pattern-based)

πŸ“ Rich Content

  • Previous year question papers with answers
  • Formula sheets for quick revision
  • Topic-wise notes
  • Markdown support with KaTeX for mathematical equations

🎯 User-Friendly Features

  • Dark/Light theme toggle
  • Responsive design for all devices
  • Advanced filtering (by year, exam type)
  • Multiple view modes (yearwise, repeated questions)
  • Search and sort functionality

🀝 Community Driven

  • Contributor system for content management
  • Open-source and collaborative

Built With

EZCrack is built using modern web technologies:

Getting Started

Prerequisites

Git - A distributed version control system for tracking changes in source code during software development.

Node.js - JavaScript runtime built on Chrome's V8 JavaScript engine. (v18 or higher recommended)

npm - Node package manager (comes with Node.js)

Installation

Local Development

  1. Clone the repository
git clone https://github.com/swymbnsl/EZCrack.git
  1. Navigate to the project directory
cd EZCrack
  1. Install dependencies
npm install
  1. Set up environment variables

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

MONGODB_URI=your_mongodb_connection_string
  1. Run the development server
npm run dev

Server will start at http://localhost:3000/

  1. Build for production
npm run build
npm start

Environment Variables

Variable Description Required
MONGODB_URI MongoDB connection string Yes

Contributing

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

  • If you have suggestions for adding or removing features, feel free to open an issue to discuss it
  • Please make sure you check your spelling and grammar
  • Create individual PR for each suggestion

Creating A Pull Request

Want to contribute to EZCrack?

  1. Fork the Project
  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

Raising An Issue

If you're experiencing any problems with EZCrack, please be sure to review our issue template before opening a new issue. The template includes a list of questions and prompts that will help us better understand the issue you're experiencing.

We kindly ask that you provide as much detail as possible when submitting an issue, including:

  • Steps to reproduce the problem
  • Expected behavior
  • Actual behavior
  • Screenshots (if applicable)
  • Browser and OS information
  • Any error messages you've encountered

This will help us identify and fix the issue more quickly.

Thank you for your cooperation, and we look forward to hearing from you!

License

Distributed under the GNU GPL-3.0 License. See LICENSE for more information.

Screenshots

Home Page

Home Page Browse through different branches and semesters

Contributors Page

Contributors Page View all the amazing people who contributed to EZCrack by providing study material

Branch and Semester Page

Branch and Semester Page Explore all different subjects available for a specific semester of a branch

Subject Page

Subject Page Explore all different units available in a subject, year-wise and most repeated PYQs

Repeated Questions

Repeated Questions Explore the most repeated concepts and patterns in PYQs for a subject, along with their frequencies

Unit Page

Unit Page Explore all different topics, their weightage, notes, formula sheets, and questions in a unit

Formula Sheet

Formula Sheet View all formulas for a unit with proper descriptions

Authors

  • Swayam Bansal - swymbnsl - Lead Developer

Made with ❀️ for students

⭐ Star us on GitHub!

About

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors