Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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*
78 changes: 37 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,21 @@
---

<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.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
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**

---

Expand All @@ -71,25 +71,20 @@ TODO: List your main features here:
TODO: Update based on your project

Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
### 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)


---

Expand Down Expand Up @@ -118,11 +113,10 @@ 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/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)

1. [Main Repository](https://github.com/AOSSIE-Org/SmartNotes)


---

Expand Down Expand Up @@ -182,11 +176,15 @@ TODO: Document main user flows:

### 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)
- Electron
- Git
Comment thread
coderabbitai[bot] marked this conversation as resolved.

- Node.js 18+ / Python 3.9+ / Flutter SDK
- npm / yarn / pnpm
- [Any specific tools or accounts needed]
Optional (for future AI features):
- Ollama for running local LLM models

### Installation

Expand All @@ -195,8 +193,8 @@ 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/SmartNotes.git
cd SmartNotes
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
```

#### 2. Install Dependencies
Expand All @@ -223,10 +221,8 @@ DATABASE_URL=your_database_url

```bash
npm run dev
# or
yarn dev
# or
pnpm dev

npm run electron
```

Comment thread
coderabbitai[bot] marked this conversation as resolved.
#### 5. Open your Browser
Expand Down
Loading