Initialize Smart Notes Electron app and update README documentation

.gitignore

@@ -324,3 +324,10 @@ TSWLatexianTemp*
 # option is specified. Footnotes are the stored in a file with suffix Notes.bib.
 # Uncomment the next line to have this generated file ignored.
 #*Notes.bib
+
+# Node / Electron
+node_modules/
+.env
+dist/
+build/
+npm-debug.log*

README.md

@@ -4,15 +4,15 @@
 <!-- Organization Logo -->
 <div align="center" style="display: flex; align-items: center; justify-content: center; gap: 16px;">
   <img alt="AOSSIE" src="public/aossie-logo.svg" width="175">
-  <img src="public/todo-project-logo.svg" width="175" />
+
 </div>
 
 &nbsp;
 
 <!-- Organization Name -->
 <div align="center">
 
-[![Static Badge](https://img.shields.io/badge/aossie.org/TODO-228B22?style=for-the-badge&labelColor=FFC517)](https://TODO.aossie.org/)
+
 
 <!-- Correct deployed url to be added -->
 
@@ -48,66 +48,49 @@
 ---
 
 <div align="center">
-<h1>TODO: Project Name</h1>
+<h1>Smart Notes</h1>
 </div>
 
-[TODO](https://TODO.stability.nexus/) is a ... TODO: Project Description.
+Smart Notes is a privacy-focused desktop application for personal knowledge management.
+It enables semantic search, automatic note linking, and AI-assisted querying of personal notes using Retrieval-Augmented Generation (RAG), all running locally on the user’s machine.
 
 ---
 
 ## 🚀 Features
 
-TODO: List your main features here:
-
-- **Feature 1**: Description
-- **Feature 2**: Description
-- **Feature 3**: Description
-- **Feature 4**: Description
+- **Local AI-powered semantic search** across personal notes
+- **RAG-based question answering** over a personal knowledge base
+- **Markdown editor for structured note-taking**
+- **Automatic note linking and knowledge graph exploration**
+- **Fully offline architecture for privacy**
 
 ---
 
 ## 💻 Tech Stack
 
-TODO: Update based on your project
-
 ### Frontend
-- React / Next.js / Flutter / React Native
-- TypeScript
-- TailwindCSS
-
-### Backend
-- Flask / FastAPI / Node.js / Supabase
-- Database: PostgreSQL / SQLite / MongoDB
-
-### AI/ML (if applicable)
-- LangChain / LangGraph / LlamaIndex
-- Google Gemini / OpenAI / Anthropic Claude
-- Vector Database: Weaviate / Pinecone / Chroma
-- RAG / Prompt Engineering / Agent Frameworks
-
-### Blockchain (if applicable)
-- Solidity / solana / cardano / ergo Smart Contracts
-- Hardhat / Truffle / foundry
-- Web3.js / Ethers.js / Wagmi
-- OpenZeppelin / alchemy / Infura
+
+- Electron
+- HTML / JavaScript
+- React (planned)
+- TipTap (planned markdown editor)
+
+### Backend / Local Services
+
+- Node.js
+
+### AI / ML
+
+- Transformers.js
+- Ollama / llama.cpp
+- Vector database (Chroma or similar)
+- Retrieval-Augmented Generation (RAG)
+
 
 ---
 
 ## ✅ Project Checklist
 
-TODO: Complete applicable items based on your project type
-
-- [ ] **The protocol** (if applicable):
-   - [ ] has been described and formally specified in a paper.
-   - [ ] has had its main properties mathematically proven.
-   - [ ] has been formally verified.
-- [ ] **The smart contracts** (if applicable):
-   - [ ] were thoroughly reviewed by at least two knights of The Stable Order.
-   - [ ] were deployed to: [Add deployment details]
-- [ ] **The mobile app** (if applicable):
-   - [ ] has an _About_ page containing the Stability Nexus's logo and pointing to the social media accounts of the Stability Nexus.
-   - [ ] is available for download as a release in this repo.
-   - [ ] is available in the relevant app stores.
 - [ ] **The AI/ML components** (if applicable):
    - [ ] LLM/model selection and configuration are documented.
    - [ ] Prompts and system instructions are version-controlled.
@@ -118,18 +101,13 @@ TODO: Complete applicable items based on your project type
 
 ## 🔗 Repository Links
 
-TODO: Update with your repository structure
+1. [Main Repository](https://github.com/AOSSIE-Org/SmartNotes)
 
-1. [Main Repository](https://github.com/AOSSIE-Org/TODO)
-2. [Frontend](https://github.com/AOSSIE-Org/TODO/tree/main/frontend) (if separate)
-3. [Backend](https://github.com/AOSSIE-Org/TODO/tree/main/backend) (if separate)
 
 ---
 
 ## 🏗️ Architecture Diagram
 
-TODO: Add your system architecture diagram here
-
 ```
 [Architecture Diagram Placeholder]
 ```
@@ -151,16 +129,12 @@ Example structure to include:
 
 ## 🔄 User Flow
 
-TODO: Add user flow diagrams showing how users interact with your application
-
 ```
 [User Flow Diagram Placeholder]
 ```
 
 ### Key User Journeys
 
-TODO: Document main user flows:
-
 1. **User Journey 1**: Description
    - Step 1
    - Step 2
@@ -178,25 +152,27 @@ TODO: Document main user flows:
 
 ---
 
-## �🍀 Getting Started
+## 🍀 Getting Started
 
 ### Prerequisites
 
-TODO: List what developers need installed
+Before running Smart Notes locally, ensure the following are installed:
+
+- Node.js (v18 or later)
+- npm (comes with Node.js)
+- Git
 
-- Node.js 18+ / Python 3.9+ / Flutter SDK
-- npm / yarn / pnpm
-- [Any specific tools or accounts needed]
+Electron is installed locally through `npm install`.
 
-### Installation
+Optional (for future AI features):
+- Ollama for running local LLM models
 
-TODO: Provide detailed setup instructions
 
 #### 1. Clone the Repository
 
 ```bash
-git clone https://github.com/AOSSIE-Org/TODO.git
-cd TODO
+git clone https://github.com/AOSSIE-Org/SmartNotes.git
+cd SmartNotes
 ```
 
 #### 2. Install Dependencies
@@ -214,38 +190,36 @@ pnpm install
 Create a `.env` file in the root directory:
 
 ```env
-# Add your environment variables here
-API_KEY=your_api_key
-DATABASE_URL=your_database_url
+# Optional: Path to local Ollama installation
+OLLAMA_PATH=/usr/local/bin/ollama
+
+# Optional: Local model name for RAG
+LOCAL_MODEL=llama3
 ```
 
 #### 4. Run the Development Server
 
+Terminal 1:
+
 ```bash
 npm run dev
-# or
-yarn dev
-# or
-pnpm dev
 ```
 
-#### 5. Open your Browser
+Terminal 2:
+
+```bash
+npm run electron
+```
+
+#### 5. Verify the Desktop App
 
-Navigate to [http://localhost:3000](http://localhost:3000) to see the application.
+After running `npm run electron`, the Smart Notes desktop window should open.
 
 For detailed setup instructions, please refer to our [Installation Guide](./docs/INSTALL_GUIDE.md) (if you have one).
 
 ---
 
-## 📱 App Screenshots
-
-TODO: Add screenshots showcasing your application
 
-|  |  |  |
-|---|---|---|
-| Screenshot 1 | Screenshot 2 | Screenshot 3 |
-
----
 
 ## 🙌 Contributing
 
@@ -257,10 +231,7 @@ Thank you for considering contributing to this project! Contributions are highly
 
 ## ✨ Maintainers
 
-TODO: Add maintainer information
-
-- [Maintainer Name](https://github.com/username)
-- [Maintainer Name](https://github.com/username)
+- Maintained by the AOSSIE team.
 
 ---
 
@@ -273,8 +244,8 @@ See the [LICENSE](LICENSE) file for details.
 
 ## 💪 Thanks To All Contributors
 
-Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂
+Thanks a lot for spending your time helping this project grow. Keep rocking 🥂
 
-[![Contributors](https://contrib.rocks/image?repo=AOSSIE-Org/TODO)](https://github.com/AOSSIE-Org/TODO/graphs/contributors)
+[![Contributors](https://contrib.rocks/image?repo=AOSSIE-Org/SmartNotes)](https://github.com/AOSSIE-Org/SmartNotes/graphs/contributors)
 
 © 2025 AOSSIE