Merge branch 'main' into main

This commit is contained in:
Patrick 2024-09-23 16:35:50 +02:00
commit 6ea8d31620
4 changed files with 54 additions and 8 deletions

View file

@ -0,0 +1,46 @@
# Installation Guide
In order to use this app, you need quite a lot of things, so buckle up.
## Dependencies
Install the following:
https://ollama.com/download
https://www.python.org/downloads/
https://nodejs.org/en/download/prebuilt-installer
For Linux and NodeJS, see:
https://nodejs.org/en/download/package-manager/all
## Running the project for the first time
In order to now actually run the program, you have to open a terminal in the project folder, then you can run:
```
npm install
cd py
pip install -R requirements.txt
```
In case you need a virtual environment however, we provide a custom install.sh file for GNU/Linux.
```
sh install.sh
```
From then on, you can run the project by:
1. Opening two terminal windows, one in the main project folder, and one in the py subfolder.
2. In the py subfolder, you will run:
```
python3 api.py
```
3. In the main project folder, you will run:
```
npm run dev
```
4. Open http://localhost:3000/ in your browser.
5. Enjoy!

View file

@ -118,8 +118,3 @@ class API:
ssl_context = ("cert.pem", "key.pem")
self.app.run(debug=True, host='0.0.0.0', port=5000)
if __name__ == '__main__':
api = API()
api.run()

7
py/run.py Normal file
View file

@ -0,0 +1,7 @@
import os
import webview
os.system("python api.py")
webview.create_window('Hello world', 'http://localhost:3000')
webview.start()

View file

@ -1,3 +1 @@
import webview
webview.create_window('Interstellar AI', 'http://localhost:3000')
webview.start()