Shobdo Logo

Getting Started

Follow these steps to get Shobdo running on your local machine.

Prerequisites

  • Node.js 20+ installed
  • SQLite dictionary databases (see Data Sources)

Installation

git clone https://github.com/your-org/shobdo.git
cd shobdo/web
npm install

Configuration

Create a .env file in the web/ directory:

# Path to the dictionaries folder
DICTIONARIES_PATH=../dictionaries

Note: The SQLite databases must be accessible at the path specified. Use an absolute path for production deployments.

Development

npm run dev

The app will start on http://localhost:3000 with Turbopack for fast hot module replacement.

Production Build

npm run build
npm run start