Documentation

Getting Started

HoiR is a desktop application for task and memo management with AI-powered features.

Requirements

• Node.js 18 or later
• Python 3.10 or later (for server)
• PostgreSQL 14 or later
• OpenRouter API key (for AI features)

Installation

1. Clone the repository

git clone https://github.com/HoRi0506/HoiR.git
cd HoiR

2. Set up the server

cd app/server
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
cp .env.example .env
alembic upgrade head
uvicorn app.main:app --reload

3. Set up the desktop app

cd app/desktop
npm install
npm run dev

Building for Production

cd app/desktop
npm run dist