Skip to content

Kuberwastaken/engram

Repository files navigation

ENGRAM Logo

E N G R A M

The Centralized, No BS Open-Source Hub for IP University Study Materials

Built for IPU Students Version Pre-Alpha License Apache 2.0

ENGRAM Desktop Interface
Desktop Experience
ENGRAM Mobile Interface
Mobile Experience

Project Overview

ENGRAM is a modern, open-source web platform designed to centralize all study materials for IP University students across 8 engineering branches and semesters.

ENGRAM is and will always stay free to access with no ads and no trackers. It aims to provide instant access to notes, previous year questions, lab manuals, and comprehensive resources without the typical friction of academic resource hunting or unreliable websites.

Born from Frustration, Built for (potential) Solutions

"I don't know about you, but during exam prep, I don't like having to open 4 different websites, 2 drive links and 4 WhatsApp groups just to get good material. Sometimes the websites are down, have bad UI and are filled with ads, half the notes are outdated or just confusing. This was me literally two days before our last exam and I honestly had it. That's why I started making ENGRAM."

Project Overview

ENGRAM is a modern, open-source web platform designed to centralize all study materials for IP University students across 8 engineering branches and semesters.

ENGRAM is and will always stay free to access with no ads and no trackers. It aims to provide instant access to notes, previous year questions,

What We Have Now

  • βœ… Aggregated Content - Notes from Dotnotes, SyllabusX, and Fifteenfourteen (with proper credits)
  • βœ… Clean Interface - Modern, space-themed UI with no ads or trackers
  • βœ… Smart Organization - Branch and semester-based structure
  • βœ… Google Drive Integration - Currently using JSON metadata with Google Drive links for 10,000+ materials

What's Coming Next

  • 🚧 Dedicated Materials Repository - Moving away from Google Drive to a proper GitHub-based system
  • 🚧 Community Upload System - Easy pull request workflow for material contributions
  • 🚧 Real-time Updates - Always current materials with community maintenance
  • 🚧 Contributor Recognition - Your name on every note you upload

Note: We're currently using JSONs with Google Drive links, but we're working toward a dedicated repository for notes. It's challenging to manage 10,000+ notes and we're still not complete, but we're committed to making it happen! The transition will


Scattered Resources
Most notes on present sites are old, new assignments don't get uploaded, and you REALLY have to dig to find quality material.
Outdated Content
Old notes, old papers, outdated assignments. Without active maintenance, platforms become digital graveyards.
Poor User Experience
Bad UI, ads everywhere, unreliable websites that go down during exam time when you need them most.

The Sustainability Challenge


Continuous Updates
Syllabus changes, new subjects emerge, old materials become outdated. Without active maintenance, ENGRAM becomes just another dead repository.

Content Quality
The best notes come from students who just mastered the subject. Your fresh perspective and recently created materials are invaluable.

Network Effects
The more students contribute, the better ENGRAM becomes for everyone. We need critical mass to become the go-to resource.

The Vision: A Legacy That Outlives Us

  • 🎯 The First Stop - Every IPU student's go-to resource for any subject
  • πŸ† Quality Guaranteed - Peer-reviewed content that students actually trust
  • πŸš€ Always Current - Real-time updates as syllabi change and new materials emerge
  • 🀝 Student-Led - Decisions made by and for the community
  • 🌟 Recognition System - Contributors get credited for every upload
  • πŸ”„ Self-Sustaining - A resource that evolves and improves with each batch of students

"I want us to create a resource that out-lives us even after graduation, constantly evolves and is a token from us to our future juniors."

ENGRAM's Solution:


Centralized Hub
Everything in one place

Smart Organization
Branch & semester based structure

Instant Access
No registration, no barriers

Community Driven
By students, for students
πŸ’‘ ENGRAM becomes powerful only when WE make it powerful together

Key Features

πŸŽ“ Academic Coverage

  • 8 Engineering Branches - AIDS, AIML, CIVIL, CSE, ECE, EEE, IT, MECH
  • 8 Semester Range - Complete undergraduate coverage
  • Comprehensive Resources - Syllabus, Notes, PYQs, Lab materials, Books
  • Special Collections - Akash notes and actually decent youtube lectures

🌌 Cosmic User Experience

  • Space-themed Interface - Beautiful dark UI with starfield animations
  • Responsive Design - Works perfectly on mobile, tablet, and desktop
  • Smart Navigation - Remembers your branch/semester preferences
  • Instant Loading - Fast, optimized React architecture

πŸ“š Resource Management

  • Tabbed Organization - Clean separation of different material types
  • Contributor Attribution - Recognition for community contributors
  • Download & Preview - Both options available for all materials
  • Search Integration - Quick access to specific subjects

πŸ› οΈ Technical Excellence

  • Modern Stack - React 18, TypeScript, Vite, Tailwind CSS
  • ShadCN UI - Premium component library for consistency
  • Local Storage - Persistent user preferences
  • PWA Ready - Installable as a progressive web app

Technical Architecture & Implementation

Current Technology Stack

  • Frontend: React 18 + TypeScript + Vite
  • Styling: Tailwind CSS + ShadCN UI components
  • Routing: React Router for seamless navigation
  • State: Local Storage for user preferences
  • Content: JSON metadata with Google Drive integration
  • Deployment: GitHub Pages with custom domain

Data Architecture (Current)

graph TD
    A[ENGRAM Frontend] --> B[JSON Metadata Files]
    B --> C[Google Drive Links]
    C --> D[Study Materials]
    
    B --> E[Dotnotes Content]
    B --> F[SyllabusX Content]
    B --> G[Fifteenfourteen Content]
    
    style A fill:#9f1239
    style B fill:#0369a1
    style C fill:#dc2626
    style D fill:#ea580c
Loading

Planned Architecture Migration

graph TD
    A[ENGRAM Frontend] --> B[GitHub Materials Repo]
    B --> C[Direct File Access]
    B --> D[PR-based Contributions]
    D --> E[Community Moderation]
    E --> F[Automated Integration]
    
    style A fill:#9f1239
    style B fill:#0369a1
    style D fill:#16a34a
    style E fill:#dc2626
Loading

πŸš€ Getting Started

Prerequisites

Development Requirements:

  • Node.js 18+ or Bun (recommended)
  • npm, yarn, or bun package manager
  • Modern web browser (Chrome, Firefox, Safari, Edge)
  • Git for version control

System Requirements:

  • Any modern OS (Windows, macOS, Linux)
  • 4GB+ RAM recommended
  • 1GB+ free disk space
  • Stable internet connection

Quick Installation

# Clone the repository
git clone https://github.com/kuberwastaken/engram.git
cd engram

# Install dependencies (choose one)
npm install
# or
yarn install
# or (recommended)
bun install

# Start development server
npm run dev
# or
yarn dev
# or (recommended)
bun dev

# Open your browser to http://localhost:5173

πŸ“ Project Structure

β”œβ”€β”€ public/                   # Static assets and materials
β”‚   β”œβ”€β”€ assets/              # Logo, icons, and branding
β”‚   β”œβ”€β”€ materials/           # Study materials (temporary)
β”‚   └── Content-Meta/        # Metadata for content organization
β”œβ”€β”€ src/                     # Source code
β”‚   β”œβ”€β”€ components/          # Reusable UI components
β”‚   β”‚   β”œβ”€β”€ ui/             # ShadCN UI primitives
β”‚   β”‚   β”œβ”€β”€ StarField.tsx   # Cosmic background animation
β”‚   β”‚   └── SubjectGrid.tsx # Subject listing component
β”‚   β”œβ”€β”€ pages/              # Route pages
β”‚   β”œβ”€β”€ hooks/              # Custom React hooks
β”‚   └── lib/                # Utility functions
β”œβ”€β”€ scripts/                # Data processing and migration scripts
└── package.json           # Dependencies and scripts

πŸ“š Current Content & Sources

Aggregated Content Sources

ENGRAM currently aggregates materials from multiple trusted sources, with proper attribution:


πŸ”΅ Dotnotes
Comprehensive notes across multiple branches
Full credit and attribution maintained

πŸ“˜ SyllabusX
Syllabus and structured course content
Original creators acknowledged

πŸ“– Fifteenfourteen
Additional study materials and resources
Contributors properly credited

Content Statistics

  • πŸ“Š 10,000+ Study Materials currently indexed
  • πŸŽ“ 8 Engineering Branches covered
  • πŸ“… 8 Semesters of content available
  • πŸ”— Google Drive Integration for reliable access
  • ⚑ JSON Metadata for fast loading and search

Future Content Strategy

  • πŸ“¦ Dedicated Materials Repository - Moving to GitHub-based storage
  • πŸ”„ Community Contributions - Pull request workflow for new materials
  • βœ… Quality Control - Peer review system for uploaded content
  • 🏷️ Better Tagging - Enhanced categorization and search capabilities

πŸ’« Design Philosophy

ENGRAM's interface draws inspiration from the vastness of space and the interconnected nature of knowledge:

Cosmic Visual Language

  • Deep Space Backgrounds - Gradients from deep black to cosmic blue
  • Starfield Animations - Twinkling particles that create ambient movement
  • Nebula-inspired Cards - Translucent containers with backdrop blur effects
  • Orbital Navigation - Smooth transitions that feel like floating through space

Interaction Principles

  • Gravity-defying Hovers - Elements that gently lift and glow on interaction
  • Constellation Navigation - Logical grouping of related elements
  • Stellar Performance - Smooth 60fps animations throughout
  • Universal Accessibility - Clear contrast and readable typography

πŸ“š How to Contribute Materials (Current Process)

Note: This is our current system using Google Drive links. We're working on a much better GitHub-based system!

Current Workflow

  1. Organize Your Materials - Sort by branch, semester, and subject
  2. Upload to Google Drive - Ensure public sharing is enabled
  3. Update JSON Metadata - Add entries to appropriate data files
  4. Submit Pull Request - Include proper attribution and descriptions
  5. Community Review - Materials get reviewed for quality and accuracy

Naming Conventions

  • Files: Subject_Topic_Version.pdf (e.g., DSA_LinkedLists_v2.pdf)
  • PYQs: Include year and exam type (e.g., PYQ_2023_EndSem.pdf)
  • Labs: Include experiment number (e.g., Lab05_BinaryTrees.pdf)

Future Contribution System

  • πŸ“ Direct GitHub Upload - No more Google Drive dependency
  • πŸ”„ Automated Processing - Smart categorization and metadata generation
  • βœ… Quality Checks - Automated validation and peer review
  • πŸ† Contributor Credits - Your name permanently attached to contributions
  • πŸ“± Mobile-Friendly - Easy uploads from phone during lectures

πŸ“± Usage Guide

For Students

  1. 🎯 Quick Access

    • Visit engram website (no registration required)
    • Select your branch and semester (preferences saved automatically)
    • Browse subjects and materials instantly
  2. πŸ“– Navigate Resources

    • SYLLABUS - Complete course outlines and assessment patterns
    • NOTES - Comprehensive study materials and lecture notes
    • PYQS - Previous year question papers with solutions
    • LAB - Lab manuals, experiments, and code samples
    • BOOKS - Reference books and additional reading
    • VIDEOS - Curated video lectures and tutorials
  3. ⬇️ Download & Study

    • One-click downloads for all materials
    • Preview documents before downloading
    • Mobile-optimized for studying on any device

🌟 Contributing

This is not just an open-source project - it's OUR collective responsibility to build and maintain the study hub that IPU desperately needs.

Every Contribution Matters

ENGRAM's success isn't measured by GitHub stars or code quality alone - it's measured by how many IPU students can access quality study materials when they need them most. Your contribution, no matter how small, directly impacts thousands of students.

The Collective Ownership Model

ENGRAM operates on a simple principle: Everyone benefits, everyone contributes.

graph LR
    A[Current Student] --> B[Contributes Materials]
    B --> C[ENGRAM Grows]
    C --> D[Future Students Benefit]
    D --> E[They Contribute Back]
    E --> B
    
    style A fill:#9f1239
    style C fill:#0369a1
    style D fill:#dc2626
Loading

This isn't charity work - it's enlightened self-interest:

  • πŸ“ˆ Better materials help YOU study more effectively
  • 🀝 Your contributions get recognized and credited
  • 🎯 You shape the platform to work exactly how you need it
  • πŸ’ͺ You build skills in collaboration and project management

We welcome contributions from the IPU community and beyond! Here's how you can help make ENGRAM even better:

πŸ“š Content Contributions

  • Add Study Materials - Share your notes, PYQs, lab files
  • Update Resources - Keep materials current with latest syllabus
  • Quality Review - Help verify and improve existing content
  • Organize Content - Better categorization and tagging

πŸ’» Code Contributions

  • Feature Development - New functionality and improvements
  • Bug Fixes - Resolve issues and enhance stability
  • UI/UX Enhancements - Better design and user experience
  • Performance Optimization - Faster loading and smoother animations

🎨 Design Contributions

  • Visual Assets - Icons, illustrations, branding elements
  • Animation Improvements - Enhanced cosmic effects
  • Mobile Experience - Better responsive design
  • Accessibility - Improved support for all users

πŸ“– Documentation

  • Usage Guides - Help new users get started
  • Technical Documentation - Code explanations and architecture
  • Contribution Guidelines - Clear processes for contributors
  • Video Tutorials - Visual guides for common tasks

Making ENGRAM Truly Ours

Current Status: πŸš€ Pre-Alpha but Functional - We have 10,000+ materials and growing!

The Mass Adoption Challenge:

"This project WOULD NOT be possible without mass adoption and WILL DIE DOWN if we don't get the community support it needs. Please, please share this with any friends, groups or communities you have in IPU B.Tech."

What Success Looks Like:

  • 🎯 90%+ Coverage - Every IPU subject has quality, updated materials
  • πŸ† Student Recognition - Top contributors become campus legends with their names on every upload
  • πŸ“± Platform Evolution - Features requested and built by students, for students
  • 🌍 Beyond IPU - A model that other universities can adopt and adapt
  • πŸ”„ Self-Sustaining Ecosystem - Where knowledge flows freely between generations

Your Role in This Journey:

  1. πŸ“€ Immediate Impact - Share materials you have right now
  2. πŸ”„ Ongoing Commitment - Update resources as you create new ones
  3. πŸ“’ Community Building - Encourage classmates and spread the word
  4. βœ… Quality Assurance - Review and improve existing materials
  5. πŸ’‘ Feature Requests - Help shape the platform's future development

🌟 The goal isn't just to build a study platform - it's to create a sustainable ecosystem where knowledge flows freely between IPU students across generations.

This affects ALL of us. Let's make it happen together.

πŸ”— References & Inspiration

Educational Platforms

Technical Resources

Design Inspiration

  • Linear - Clean, modern interface design
  • Vercel - Dark theme and space aesthetics
  • GitHub - Code organization and presentation
  • Notion - Content organization patterns

Community Projects

πŸ“œ License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.


🌟 Star this repository if you find it helpful!

πŸ“’ Share with your IPU friends and communities

Built with ❀️ by Kuber Mehta and the entire IPU student community

A legacy project that outlives us all - from students, for students, forever.

About

The Biggest, Centralized, No BS Open-Source hub for IP University Notes and Resources.

Topics

Resources

License

Stars

Watchers

Forks

Languages