Skip to content
l-Alli-l edited this page Jul 2, 2025 · 3 revisions

IdeaForge Wiki

Welcome to the IdeaForge Wiki! This space contains all the information you need to get started, contribute, and master IdeaForge.


📖 Overview

IdeaForge is your private, local-first sandbox for brainstorming, structuring, and developing brilliant ideas with total privacy and control. Built with a focus on:

  • Local-First Workflow: All data is stored locally in your browser's IndexedDB, ensuring your ideas never leave your machine unless you choose to export them.
  • Project & Idea Management: Organize multiple projects, add ideas within each project, and mark favorites for quick access.
  • Zero-Dependency Logic: A lightweight codebase without server dependencies or back-end, powered entirely by modern web technologies.

🚀 Key Features

  • Private Storage: Ideas and projects saved in localStorage/IndexedDB under IDEA_FORGE_LOCAL_PROJECTS.
  • Favorites & Sorting: Mark projects and ideas as favorites and display newest items first.
  • Full-Text Search: Quickly find projects or ideas by keyword.
  • Notebook-Like UI: Clean, distraction-free interface for capturing and refining ideas.
  • Export & Backup: Export projects and ideas as JSON for sharing or archival.

🛠️ Getting Started

Prerequisites

  • Node.js v18 or later
  • npm or Yarn

Installation

# Clone the repository
git clone https://github.com/agattone96/ideaforge.git
cd ideaforge

# Install dependencies
npm ci  # or yarn install

Development Server

npm run dev

Open your browser at http://localhost:3000 to view the app. Any code changes will hot-reload automatically.

Production Build

npm run build

Preview the built application locally:

npm run preview

📁 Project Structure

  • public/ — Static assets (favicon, index.html, etc.)
  • src/
    • components/ — Reusable React components
    • services/ — Data persistence & utilities (localStorageService)
    • App.tsx — Application root component
    • main.tsx — ReactDOM entry point
  • tests/ — Unit & E2E tests
  • .github/ — CI/CD workflows
  • package.json — Project metadata & scripts

⚙️ Configuration

  • LocalStorage Key
    Located in src/services/localStorageService.ts as IDEA_FORGE_LOCAL_PROJECTS
  • Environment Variables
    None required—IdeaForge is fully client-side

🤝 Contributing

We welcome improvements! Please:

  1. Fork & branch
    Create a new branch (e.g., feature/my-update)
  2. Code & test
    npm run lint
    npm test
  3. Submit a PR
    • Target branch: main
    • Provide a clear description of your changes

📄 License

Released under the MIT License:
https://github.com/agattone96/ideaforge/blob/main/LICENSE


Last updated: July 2, 2025

Clone this wiki locally