Install RumiTalk Locally Using npm

For most scenarios, Docker Compose is the recommended installation method due to its simplicity, ease of use, and reliability. If you prefer using npm, you can follow these instructions.

Prerequisites

• Node.js 18+: https://nodejs.org/en/download
• Git: https://git-scm.com/download/
• MongoDB (Atlas or Community Server)
  • MongoDB Atlas
  • MongoDB Community Server

Installation Steps

Preparation

Run the following commands in your terminal:

git clone https://github.com/danny-avila/RumiTalk.git

cd RumiTalk

cp .env.example .env

Note: If you’re using Windows 10, you might need to use copy instead of cp.

Important: Edit the newly created `.env` file to update the `MONGO_URI` with your own MongoDB instance URI.

Build and Start

Once you’ve completed the preparation steps, run the following commands:

npm ci

npm run frontend

npm run backend

Update RumiTalk

To update RumiTalk to the latest version, run the following commands:

git pull

npm ci

npm run frontend

npm run backend

Additional Setup

Unlock additional features by exploring our configuration guides to learn how to set up:

• Meilisearch integration
• RAG API connectivity
• Custom endpoints
• Other advanced configuration options
• And more

This will enable you to customize your RumiTalk experience with optional features.

see also:

• User Authentication System Setup
• AI Setup
• Custom Endpoints & Configuration