Skip to content

Yazan10x/note-polish

Repository files navigation

Note Polish

Note Polish turns messy notes into a clean, one page study sheet you can actually review. Upload a screenshot or paste text, pick a style, and generate a print ready summary in seconds.

Demo Video: YouTube link

Before and after example (heart notes): image

Pick from 1 to 5 styles to customize the output: dashboard

Accessibility Settings: Large text + spacing, bold text, high contrast, and reduced motion. image

Tech Stack

  • Next.js (TypeScript)
  • Tailwind + shadcn/ui
  • MongoDB (local via Docker)
  • OpenAI API

Run Locally

  1. Create your local env file with OpenAI key:
bash ./setup_local.sh sk-your-openai-key

Optional: Write your OpenAI key in .env.local manually:

bash ./setup_local.sh
  1. Start everything:
bash ./run_local.sh

Open:

Environment Variables

Your .env.local should include:

OPENAI_API_KEY=your_key_here
MONGODB_URI=mongodb://127.0.0.1:27077
MONGODB_DB=note_polish

Release notes

Version Date Notes
0.1.0 2025-12-17 Launch: paste or upload notes and generate a clean one page study sheet. Playground with 5 style presets (including exam or cheat sheet focused formats). Preview and download export with saved History.
0.2.0 2025-12-26 Accessibility settings page added. Toggles for large text and spacing, bold text, high contrast, and reduced motion are saved in localStorage and applied globally via html classes.

About

Note Polish turns messy notes into a clean, one page study sheet you can actually review. Upload a screenshot or paste text, pick a style, and generate a print ready summary in seconds.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors