# Lock In
## Introduction
LockIn is an all-in-one personal study assistant built with HTML, Tailwind CSS, JavaScript and Django backend. It helps students stay organised and motivated with features such as AI based Pdf Analyzer and quiz and flashcards generator, habit tracker, vision board, GitHub-style study heatmap, 90-day goals planner, Pomodoro timer, task manager and subject wise notes organiser. All data is stored locally in the browser, offering a smooth, fast, and highly interactive experience.
## Features
1. #### AI Based PDF Analyzer
2. #### **Vision Board**
3. #### AI Based Timetable generator
4. #### **Study Heatmap (GitHub-Style)**
5. #### **90-Day Goal Planner**
6. #### **Pomodoro Focus Timer**
7. #### **Task Manager**
8. #### **Notes Organizer**
## Tech Stack
| Layer | Technology |
| ------------ | -------------------------------------- |
| Frontend | HTML5,Tailwind CSS, Vanilla JavaScript |
| Backend | Django Python |
| AI | Groq |
| Data Storage | LocalStorage API |
| Deployment | Cline CLI |
## Project Architecture
```
LockIn/
├── core/
│ ├── templates/
│ │ ├── habit.html
│ │ ├── upload_pdf.html
│ │ ├── notebook.html
│ │ ├── ...
│ ├── static/
│ ├── forms.py
│ ├── groq_client_models.py
│ ├── groq_client.py
│ ├── utils.py
│ ├── views.py
│ ├── urls.py
│ └── models.py (you don’t really use DB much due to localStorage)
│
├── LockIn/
│ ├── settings.py
│ ├── urls.py
│ ├── wsgi.py
│ └── asgi.py
│
├── pdfs/
├── manage.py
└── db.sqlite3
```
## Features Description
## **AI-Based PDF Analyzer**
This is one of the most powerful features of your app.
Users upload a PDF (study notes, chapters, textbooks), and your backend AI:
* Extracts text
* Summarizes content
* Detects key concepts
* Extracts definitions, formulas, and bullet points
* Generates Q\&A pairs
* Creates flashcards
* Creates quizzes
**How it works:**
* Django receives the uploaded PDF
* PDF text is extracted
* `groq_client.py` sends the extracted text to an AI model
* The backend returns structured JSON → displayed in the UI
**Why it’s useful:**\
It converts heavy PDFs into readable summaries and instant study material.
## **Habit Tracker**
The Habit Tracker helps users build consistency by allowing them to track daily habits.\
Users can:
* Add new habits
* Check/uncheck habits
* Delete habits
* Automatically save habits to the browser
**How it works:**\
Each habit is stored in localStorage with a “done” status. When users interact with a habit, the UI updates instantly without page reload.
**Why it's useful:**\
Develops discipline and creates a daily tracking routine.
## **Vision Board**
The Vision Board is a motivational space where users can visualize their goals and dreams. Users can:
* Upload images (inspiration, goals, rewards, quotes)
* Add motivational text
* View all inspiration on a dynamic grid
**How it works:**\
Images are stored as Base64 in localStorage and rendered dynamically on the page.
**Why it’s useful:**\
Vision boards boost motivation, positivity, and long-term goal alignment.
## **Study Heatmap (GitHub-style)**
A visual calendar that displays how much the user studied each day.\
Color intensity indicates minutes studied:
* Gray → no study
* Light green → low study
* Medium green → moderate
* Dark green → intense study
Users can click a day to add study minutes.
**How it works:**\
Each day is linked to a date key, and minutes are tracked in localStorage.\
The heatmap updates color based on thresholds.
**Why it’s useful:**\
Shows consistency and builds long-term study streaks.
## **90-Day Goals Planner**
Allows users to design long-term goals and track them for 90 days.\
Users can set:
* A main goal
* A “why” explanation
* Multiple milestones
* Weekly reflections
* Daily progress entries for all 90 days
* Delete/reset the entire plan when finished
**How it works:**\
All goal details + daily notes are stored as structured JSON in localStorage.\
The UI generates 90 day-cards dynamically.
**Why it’s useful:**\
90-day plans are scientifically proven to help people achieve major goals.
## **Notes App**
The Notes section is a quick notepad where users can:
* Create multiple notes
* Edit or delete notes
* Save notes automatically
* Reopen notes at any time
**How it works:**\
Notes are stored as an array in localStorage and displayed in the UI.
**Why it’s useful:**\
Perfect for storing formulas, summaries, reminders, or class notes.
## **Pomodoro Focus Timer**
A productivity timer based on the 25/5 Pomodoro technique.
Features:
* Start / Pause / Reset
* Visual countdown
* Lofi Songs
* Mini notes
* Digital clock
* Background change option
**How it works:**\
Runs on frontend JavaScript with interval timers.
**Why it’s useful:**\
Boosts focus and prevents burnout with structured time blocks.
## Deployment
OnRender.com
The website is live on-
## Testing
Manual Testing Checklist
* [x] PDF Quiz and flashcard generate
* [x] Daily Timetable
* [x] 90 Day habit track and delete
* [x] Vision Board add quotes and Images
* [x] Pomodoro Timer
* [x] Lofi Songs, Mini Notes add and delete
* [x] Notes make subject wise folders
## Future Enhancements
* Analytics dashboard (graphs & stats)
* Study streak achievements
* Add friends
## Conclusion
LockIn integrates productivity, motivation, and long-term planning into a single powerful web app.\
With a clean modern UI and fully persistent browser data, it empowers students to stay consistent, visualize their progress, and build strong study habits.