Skip to content

Devika is the first open-source implementation of an Agentic Software Engineer. Initially started as an open-source alternative to Devin.

Python

Add Quick Start: detailed Installation steps

Mufeed VHf3c8bad9350c
diff --git a/README.md b/README.md
index 8103915..62b6b32 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,7 @@
- [About](#about)
- [Key Features](#key-features)
- [System Architecture](#system-architecture)
+- [Quick Start](#quick-start)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [Configuration](#configuration)
@@ -65,6 +66,32 @@ Devika's system architecture consists of the following key components:
Read [**ARCHITECTURE.md**](https://github.com/stitionai/devika/blob/main/ARCHITECTURE.md) for the detailed documentation.
+## Quick Start
+
+The easiest way to run the project locally:
+
+1. Install `uv` - Python Package manager (https://github.com/astral-sh/uv)
+2. Install `bun` - JavaScript runtime (https://bun.sh/)
+3. Install and setup `Ollama` (https://ollama.com/)
+
+Set the API Keys in the `config.toml` file. (This will soon be moving to the UI where you can set these keys from the UI itself without touching the command-line, want to implement it? See this issue: https://github.com/stitionai/devika/issues/3)
+
+Then execute the following set of command:
+
+```
+ollama serve
+git clone https://github.com/stitionai/devika.git
+cd devika/
+uv venv
+uv pip install -r requirements.txt
+cd ui/
+bun install
+bun run dev
+python3 devika.py
+```
+
+Docker images will be released soon. :raised_hands:
+
## Installation
To install Devika, follow these steps: