Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

changed none working ARCHITECTURE.md link in README.md and UNDER_THE_HOOD.md #651

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
8fb3c06
Update README.md
alexanderbehrens1978 Oct 6, 2024
cd227ab
Update README.md
alexanderbehrens1978 Oct 6, 2024
61b9f8b
devika.py aktualisieren
alexanderbehrens1978 Oct 6, 2024
0f4c51f
Update README.md
alexanderbehrens1978 Oct 8, 2024
712082b
Update README.md
alexanderbehrens1978 Oct 8, 2024
e350363
Update README.md
alexanderbehrens1978 Oct 8, 2024
8f1aadc
Update README.md
alexanderbehrens1978 Oct 8, 2024
822b9a0
Update README.md
alexanderbehrens1978 Oct 8, 2024
d01c5c7
Update README.md
alexanderbehrens1978 Oct 8, 2024
9b48666
Update README.md
alexanderbehrens1978 Oct 8, 2024
d4cfbb5
Update README.md
alexanderbehrens1978 Oct 8, 2024
cf965f3
Update README.md
alexanderbehrens1978 Oct 8, 2024
9855bbd
Update README.md
alexanderbehrens1978 Oct 8, 2024
b274a70
Update README.md
alexanderbehrens1978 Oct 8, 2024
614eb31
Update devika.py
alexanderbehrens1978 Oct 8, 2024
66de63e
Update README.md
alexanderbehrens1978 Oct 8, 2024
12883d4
Update README.md
alexanderbehrens1978 Oct 8, 2024
2106a6f
Update README.md
alexanderbehrens1978 Oct 8, 2024
74da6a2
Update README.md
alexanderbehrens1978 Oct 8, 2024
6a2e14d
Update README.md
alexanderbehrens1978 Oct 8, 2024
594dae6
Update README.md
alexanderbehrens1978 Oct 9, 2024
3023d61
Update README.md
alexanderbehrens1978 Oct 9, 2024
9d5b942
Update README.md
alexanderbehrens1978 Oct 9, 2024
9b7f97d
Update README.md
alexanderbehrens1978 Oct 9, 2024
035c6d0
README.md aktualisieren
alexanderbehrens1978 Oct 9, 2024
4ec321e
Update requirements.txt
alexanderbehrens1978 Oct 9, 2024
50de197
Update README.md
alexanderbehrens1978 Oct 9, 2024
237696c
Update README.md
alexanderbehrens1978 Oct 9, 2024
5a0b6e1
Update README.md
alexanderbehrens1978 Oct 9, 2024
f4fdd76
Update README.md
alexanderbehrens1978 Oct 9, 2024
e8aaeb2
Add files via upload
alexanderbehrens1978 Oct 9, 2024
0095755
Update README.md
alexanderbehrens1978 Oct 9, 2024
f41c4d9
Rename get-ollama-modells.sh to get-ollama-models.sh
alexanderbehrens1978 Oct 9, 2024
abb0c21
Update README.md
alexanderbehrens1978 Oct 9, 2024
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
75 changes: 66 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,20 +54,55 @@ Read [**README.md**](docs/architecture) for the detailed documentation.


## Getting Started

### Requirements
```
Version's requirements
- Python >= 3.10 and < 3.12
- NodeJs >= 18
- bun
```

- Nvidia Driver installation

https://linuxconfig.org/how-to-install-nvidia-drivers-on-ubuntu-24-04

nvtop to see installed Nvidia Cards

- Python >= 3.10 and < 3.12

sudo apt update && sudo apt upgrade

sudo apt install python3 python-is-python3

- NodeJs >= 18 Installation
[NodeJs >= 18 Installation](https://linuxconfig.org/how-to-install-node-js-on-ubuntu-24-04)

sudo apt install nodejs

sudo apt install npm

node -v

- Pip Installation

sudo apt install pip

python3 -m pip config set global.break-system-packages true

als Alternative im uv pip installieren ???

sudo apt install python3-pip

- Install uv - Python Package manager [download](https://github.com/astral-sh/uv)

$ pip install uv

- Install bun - JavaScript runtime [download](https://bun.sh/docs/installation)
- For ollama [ollama setup guide](docs/Installation/ollama.md) (optinal: if you don't want to use the local models then you can skip this step)

curl -fsSL https://ollama.com/install.sh | sh

./get-ollama-models.sh



- For API models, configure the API keys via setting page in UI.

Keys without <>



### Installation

Expand Down Expand Up @@ -99,6 +134,7 @@ To install Devika, follow these steps:
```
5. Start the Devika server:
```bash
npm install @sveltejs/adapter-node
python devika.py
```
6. if everything is working fine, you see the following output:
Expand All @@ -113,6 +149,27 @@ To install Devika, follow these steps:
```
8. Access the Devika web interface by opening a browser and navigating to `http://127.0.0.1:3001`

9. Install xterm in wsl

sudo apt install xterm

10. Windows run Xming Server from http://www.straightrunning.com/XmingNotes/#head-16

11. Change Fontsize in xterm

sudo apt install x11-xserver-utils

vi ~./Xresources

xterm*font: *-fixed-*-*-*-18-*

run xrdb -merge ~/.Xresources

14. Install Code

sudo snap install --classic code


### how to use

To start using Devika, follow these steps:
Expand Down
8 changes: 2 additions & 6 deletions devika.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,13 @@


app = Flask(__name__)
CORS(app, resources={r"/*": {"origins": # Change the origin to your frontend URL
[
"https://localhost:3000",
"http://localhost:3000",
]}})
CORS(app)
app.register_blueprint(project_bp)
socketio.init_app(app)


log = logging.getLogger("werkzeug")
log.disabled = True
log.disabled = False


TIKTOKEN_ENC = tiktoken.get_encoding("cl100k_base")
Expand Down
4 changes: 2 additions & 2 deletions docs/architecture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ Devika's system architecture consists of the following key components:
8. **Knowledge Base**: Stores and retrieves project-specific information, code snippets, and learned knowledge for efficient access.
9. **Database**: Persists project data, agent states, and configuration settings.

Read [ARCHITECTURE.md](https://github.com/stitionai/devika/Docs/architecture/ARCHITECTURE.md) for the detailed architecture of Devika.
Read [UNDER_THE_HOOD.md](https://github.com/stitionai/devika/Docs/architecture/UNDER_THE_HOOD.md) for the detailed working of Devika.
Read [ARCHITECTURE.md](https://github.com/stitionai/devika/blob/main/docs/architecture/ARCHITECTURE.md) for the detailed architecture of Devika.
Read [UNDER_THE_HOOD.md](https://github.com/stitionai/devika/blob/main/docs/architecture/UNDER_THE_HOOD.md) for the detailed working of Devika.
43 changes: 43 additions & 0 deletions get-ollama-models.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
#! /bin/bash
echo "/usr/local/bin/ollama pull llama3.2"
echo
/usr/local/bin/ollama pull llama3.2
echo
echo "/usr/local/bin/ollama pull llama3.1"
/usr/local/bin/ollama pull llama3.1
echo
echo "/usr/local/bin/ollama pull llama3"
/usr/local/bin/ollama pull llama3
echo
echo "/usr/local/bin/ollama pull gemma"
/usr/local/bin/ollama pull gemma
echo
echo "/usr/local/bin/ollama pull qwen"
/usr/local/bin/ollama pull qwen
echo
echo "/usr/local/bin/ollama pull qwen2"
/usr/local/bin/ollama pull qwen2
echo
echo "/usr/local/bin/ollama pull mistral"
/usr/local/bin/ollama pull mistral
echo
echo "/usr/local/bin/ollama pull phi3:14b"
/usr/local/bin/ollama pull phi3:14b
echo
echo "/usr/local/bin/ollama pull phi3:3.8b"
/usr/local/bin/ollama pull phi3:3.8b
echo
echo "/usr/local/bin/ollama pull codellama"
/usr/local/bin/ollama pull codellama
echo
echo "/usr/local/bin/ollama pull qwen2.5"
/usr/local/bin/ollama pull qwen2.5
echo
echo "/usr/local/bin/ollama pull llama2"
/usr/local/bin/ollama pull llama2
echo
echo "/usr/local/bin/ollama pull gemma2"
/usr/local/bin/ollama pull gemma2
echo
echo "/usr/local/bin/ollama pull llama3.1:70b"
/usr/local/bin/ollama pull llama3.1:70b
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ orjson
gevent
gevent-websocket
curl_cffi
vite
shutils