Skip to content

README.md

Latest commit

 

History

History
163 lines (114 loc) · 4 KB

README.md

File metadata and controls

163 lines (114 loc) · 4 KB

NOTESLITE (Next.js + Prisma + PostgreSQL)

NOTESLITE runs as a single Next.js app with:

  • Next.js (App Router)
  • React + TypeScript
  • Prisma ORM
  • PostgreSQL
  • Clerk authentication

Prerequisites

  • Node.js 20+
  • npm 10+
  • PostgreSQL running locally or remotely
  • Clerk project keys

Installation

  1. Install dependencies:
npm install
  1. Create your local environment file:
cp .env.example .env
  1. Fill .env with valid values:
  • DATABASE_URL
  • NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY
  • CLERK_SECRET_KEY
  • NEXT_PUBLIC_CLERK_SIGN_IN_URL=/auth/sign-in
  • NEXT_PUBLIC_CLERK_SIGN_UP_URL=/auth/sign-up
  • NEXT_PUBLIC_CLERK_SIGN_IN_FALLBACK_REDIRECT_URL=/dashboard
  • NEXT_PUBLIC_CLERK_SIGN_UP_FALLBACK_REDIRECT_URL=/dashboard

Database Setup

Apply existing migrations:

npm run prisma:migrate

Generate Prisma Client (optional, usually auto-generated during migrate):

npm run prisma:generate

Open Prisma Studio (optional):

npm run prisma:studio

Run the App

Start development server:

npm run dev

Open http://localhost:3000.

Available Scripts

  • npm run dev - start Next.js in development mode
  • npm run build - create production build
  • npm run start - run production server
  • npm run lint - run ESLint
  • npm run prisma:migrate - apply dev migrations with Prisma
  • npm run prisma:generate - generate Prisma client
  • npm run prisma:studio - open Prisma Studio

Project Structure

  • app/ - Next.js routes, pages, and API handlers
  • components/ - UI and page shell components
  • lib/ - shared server utilities (auth, Prisma helpers)
  • prisma/schema.prisma - database models
  • middleware.ts - auth route protection

Authentication Routes

  • Sign in: /auth/sign-in
  • Sign up: /auth/sign-up
  • /auth redirects to /auth/sign-in

Important Note About Migrations

Do not run npm run prisma:migrate -- --name init on an existing project setup unless you are intentionally creating a brand-new migration. For normal setup, use:

npm run prisma:migrate

Legacy Folders

frontend/ and backend/ are legacy reference folders from the older split architecture and are not used by the current runtime.

Pull Request Format

When submitting a PR, please use the following format for clear communication:

Template

Name:
[Brief descriptive title of the PR]

Work Done:
[Concise summary of what was implemented or fixed, including any context about why the changes were needed]

Purpose:
[Explain the goal and benefit of these changes — what problem does it solve or what improvement does it provide?]

Changes Made:
- [Bullet point for each significant change]
- [Include both functional and refactoring changes]
- [Mention any breaking changes if applicable]

Files Changed:
- [List the main files that were modified]

Test/Verification:
- [How to verify the changes work correctly]
- [Any test commands or manual testing steps]
- [Build and lint verification status]

Example

Name:
NOTESLITE Cleanup - Remove Unused Canvas Leftovers

Work Done:
Removed stale canvas-related code that was no longer used in the board client, including unused imports, unused state, and dead helper callbacks that were left behind after the canvas work was simplified.

Purpose:
This cleanup keeps the board client compiling cleanly, reduces noise in the component, and removes code paths that referenced undefined or unused canvas state.

Changes Made:
- Removed unused canvas imports from workspace-board-client.tsx
- Removed unused canvas state and updater hooks that were not wired into the current UI
- Removed the unused canvas branch from palette click handling
- Kept the existing board workflow intact while trimming dead code from the component
- Fixed the build error caused by the missing CanvasViewMode reference during the cleanup pass

Files Changed:
- workspace-board-client.tsx

Test/Verification:
- npm run build passed after the cleanup
- Confirmed the repo compiles successfully with the unused canvas leftovers removed