Skip to content

README.md

Latest commit

 

History

History
110 lines (87 loc) · 3.03 KB

README.md

File metadata and controls

110 lines (87 loc) · 3.03 KB
Raw

Welcome to Noteracy 👋

A seamless, distraction-free workspace for capturing and organizing your thoughts.

Overview

Noteracy is a modern note-taking application designed for speed and simplicity. Built with a responsive Master-Detail architecture, it allows you to:

  • Create & Edit: Write notes instantly with a clean, unstyled editor.
  • Global Search: Find any note in milliseconds using the built-in Command Palette (Cmd+K).
  • Manage Securely: Authenticate seamlessly via Google OAuth to keep your data private.

Tech Stack

  • Frontend: React.js, Tailwind CSS v3, Radix UI Primitives, cmdk
  • Backend: Node.js, Express.js, Passport.js (Google OAuth 2.0)
  • Database: MongoDB (Mongoose)

Architecture

graph TD
  subgraph Client [React Frontend - Tailwind + Radix UI]
    Landing[Landing Page]
    DashboardLayout[Master-Detail Layout]
    Sidebar[Left Sidebar & Notes List]
    Editor[Note Editor View]
    CmdK[Command Palette Search]
  end

  subgraph Server [Express & Node.js Backend]
    AuthRoute[Auth Routes]
    DashRoute[Dashboard API Routes]
    AuthMW[Session Middleware]
  end

  subgraph Services [External Services]
    MongoDB[(MongoDB Atlas)]
    GoogleOAuth[Google OAuth 2.0]
  end

  %% Client Flow
  Landing -- "Sign In" --> AuthRoute
  DashboardLayout --> Sidebar
  DashboardLayout --> Editor
  DashboardLayout --> CmdK

  %% Server Interaction
  Sidebar -- "Fetch/Delete/Rename" --> DashRoute
  Editor -- "Create/Update Notes" --> DashRoute
  CmdK -- "Search Query" --> DashRoute
  
  %% Auth & Data Flow
  AuthRoute -- "Authenticate" --> GoogleOAuth
  AuthRoute -- "Manage Sessions" --> MongoDB
  DashRoute -- "Protect Routes" --> AuthMW
  DashRoute -- "Query/Save Data" --> MongoDB
Loading

Design Principles:

  • Centralized Tokens: All design tokens (colors, fonts, spacing) are managed in client/src/styles/tokens.css.
  • Accessible Primitives: Interactivity relies on Radix UI components, ensuring ARIA compliance and keyboard navigation.

Local Development

1. Install Dependencies

npm install
cd client && npm install

2. Environment Variables

Copy .env.example to .env in the root directory:

cp .env.example .env

Ensure the following variables are set:

PORT=3175
MONGODB_URI=mongodb://localhost:27017/noteracy
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
GOOGLE_CALLBACK_URL=http://localhost:3175/google/callback
CLIENT_URL=http://localhost:3000
SESSION_SECRET=your_secure_session_secret

3. Run the App

Start both the backend server and React frontend concurrently (in separate terminals):

Backend:

npm run dev

Frontend:

cd client && npm start

Deployment

This project is configured for seamless deployment on platforms like Render. The npm run build script at the root handles installing client dependencies and compiling the React application automatically.

If this project helped you, please give it a ⭐️!