Skip to content

README.md

Latest commit

 

History

History
executable file
·
142 lines (99 loc) · 3.64 KB

README.md

File metadata and controls

executable file
·
142 lines (99 loc) · 3.64 KB

FireNotes

FireNotes Logo Svelte TypeScript License

A modern, distraction-free markdown editor built with Svelte

✨ Live Preview • 🎨 Syntax Highlighting • 📑 Multi-Document • 🌙 Dark Mode • 💾 Auto-Save

📖 About

FireNotes is a modern, elegant markdown editor developed to provide a fluid and productive writing experience. It's a fork of Aire with an organized source structure.

🎯 Features

  • ✍️ Creative writing - Articles, blog posts, technical documentation
  • 📝 Notes - Quick notes and personal organization
  • 📚 Documentation - Project documentation, READMEs, manuals
  • 💻 Development - Technical writing with code support

🚀 Getting Started

Prerequisites

Software Minimum Version
Node.js v16.0.0+
npm v8.0.0+ (or yarn/pnpm)
Git Any recent version

Installation

# Clone the repository
git clone https://github.com/yourusername/firenotes.git

# Enter the directory
cd firenotes

# Install dependencies
npm install

# Start the development server
npm run dev

Accessing the Application

After starting, the application will be available at:

http://localhost:5173

Production Build

# Create the optimized build
npm run build

# Preview the build locally
npm run preview

🛠️ Technologies

This project was built with the following technologies:

Frontend

Technology Version Purpose
Svelte 4.x Reactive framework
TypeScript 5.x Static typing
Vite 5.x Bundler and dev server

Libraries

Library Version Purpose
Marked 11.x Markdown Parser
highlight.js 11.x Syntax highlighting
lucide-svelte 0.x SVG icons
KaTeX 0.x Math rendering

📊 Project Structure

firenotes/
├── src/
│   ├── components/       # Svelte components
│   │   ├── EmojiPicker.svelte
│   │   ├── CommandPalette.svelte
│   │   └── SearchPanel.svelte
│   ├── stores/           # Svelte stores (global state)
│   │   └── stores.ts
│   ├── styles/           # Global styles
│   │   └── app.css
│   ├── assets/           # Static assets
│   │   └── svelte.svg
│   ├── lib/              # Library components
│   │   └── Counter.svelte
│   ├── App.svelte        # Root component
│   └── main.ts           # Entry point
├── public/               # Static files
├── index.html            # HTML template
├── package.json
├── svelte.config.js      # Svelte configuration
├── vite.config.ts        # Vite configuration
├── tsconfig.json         # TypeScript configuration
└── README.md

📜 License

This project is licensed under the GNU General Public License v3.0.

See the LICENSE file for more information.

⭐️ If this project was useful, consider giving it a star!