Skip to content

ajsteiger/Sketchbyte-Notes-Taking-App

Β 
Β 

Repository files navigation

Sketchbyte

The Visual Workspace for Every Student

Whiteboard Β· Code Diagrams Β· AI Study Planner β€” 100% Free Forever

Live App Download APK License


Features

Feature Description
Infinite Canvas Pan, zoom, draw on an infinite dark canvas with no size limits
9 Drawing Tools Rectangle, circle, arrow, pencil, text, eraser, select and pan
Auto-Save Everything saved instantly in your browser, no account needed
Export Anywhere Export as PNG, SVG, PDF or .antigravity JSON files
Multiple Boards Unlimited canvas boards β€” create, name and switch in one click
Dev Templates Flowcharts, DB schemas, DSA visualizations ready to use
Keyboard Shortcuts Every tool has a hotkey: Ctrl+Z undo, Delete, Ctrl+A select all
Code to Diagram Paste code and get an instant class diagram β€” 12+ languages
AI Study Planner Smart timetable, spaced repetition, streak tracker, 100% offline
Firebase Auth Google and email sign-in to protect your boards

Install on Any Device

Sketchbyte is a PWA (Progressive Web App) β€” install it like a native app on any platform in under 60 seconds. No App Store required.

Platform Method
Android Chrome > Menu (three dots) > Add to Home Screen
iPhone / iPad Safari > Share > Add to Home Screen
Windows Chrome or Edge > Install icon in address bar
macOS Chrome > Install icon in address bar

Full install guide: sketchbyte.vercel.app/download


Download APK

Option 1 β€” GitHub Releases (Automated, Signed)

Every version tag automatically builds a signed .apk via GitHub Actions (Bubblewrap TWA):

git tag v1.0.0
git push origin v1.0.0

The APK will appear under Releases within ~5 minutes.

App Stores

Store Link Status
GitHub Releases View Releases Auto-published on tag
Aptoide Developer Portal Upload APK manually
APKPure Developer Portal Upload APK manually

Development Setup

Prerequisites

  • Node.js 18+
  • npm or yarn

Run Locally

# Clone the repo
git clone https://github.com/dhruva8214/Sketchbyte-Notes-Taking-App.git
cd Sketchbyte-Notes-Taking-App

# Install dependencies
npm install

# Start dev server
npm run dev

Open http://localhost:5173

Build for Production

npm run build

Output goes to dist/. Ready to deploy on Vercel, Netlify, or any static host.


Setting Up APK Builds (GitHub Actions)

The workflow in .github/workflows/release.yml automatically builds a signed APK on every v* tag push.

One-time Setup

1. Generate your signing keystore (requires Java):

.\scripts\generate-keystore.ps1

2. Add 4 GitHub Secrets β€” go to repo > Settings > Secrets > Actions:

Secret Value
KEYSTORE_BASE64 Contents of keystore-base64.txt
KEY_ALIAS sketchbyte
KEYSTORE_PASSWORD Your chosen password
KEY_PASSWORD Your chosen key password

3. Publish a release:

git tag v1.0.0
git push origin v1.0.0

Important: Never commit *.keystore or keystore-base64.txt to Git β€” they are already in .gitignore.


Tech Stack

Layer Technology
Framework React 19 + TypeScript
Build Tool Vite 7
Canvas Konva / React-Konva
Styling Vanilla CSS + inline styles
Auth Firebase (Google + Email)
PWA vite-plugin-pwa + Workbox
Android Bubblewrap TWA via GitHub Actions
State Zustand
Router React Router v7
Deploy Vercel

Project Structure

src/
β”œβ”€β”€ pages/
β”‚   β”œβ”€β”€ Landing.tsx          # Home page
β”‚   β”œβ”€β”€ DownloadPage.tsx     # Download and install guide
β”‚   β”œβ”€β”€ CanvasApp.tsx        # Whiteboard app
β”‚   β”œβ”€β”€ CodeToDiagramPage    # Code to Class Diagram tool
β”‚   β”œβ”€β”€ StudyPlannerPage     # AI Study Planner
β”‚   └── AuthPage.tsx         # Login / Register
β”œβ”€β”€ canvas/                  # Konva canvas components
β”œβ”€β”€ components/              # Shared UI components
β”œβ”€β”€ store/                   # Zustand state stores
β”œβ”€β”€ utils/                   # Diagram generator, code parser
└── firebase/                # Firebase config and auth

.github/workflows/
└── release.yml              # Auto APK build and GitHub Release

scripts/
└── generate-keystore.ps1    # Android signing key generator

twa-manifest.json            # Bubblewrap TWA configuration

Deploy

Sketchbyte is deployed on Vercel with automatic deployments from main.

Deploy with Vercel


Author

Built with love by Dhruva M β€” Think Without Limits.

Sketchbyte is 100% free, forever. No paywalls, no subscriptions. Built for students, by a student.

About

🌌 Free, unlimited visual whiteboard for students & developers. Infinite canvas, 9 drawing tools, dev templates (System Design, DB Schema, DSA), PNG/SVG export, multi-board workspace & keyboard shortcuts. No login. No paywalls. Built with React, Konva.js & TypeScript.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 87.4%
  • CSS 10.9%
  • PowerShell 1.2%
  • Other 0.5%