Getting Started
On this page
Start the backend
You need :
make
- Docker if you want to run the application in Docker
- Python 3.12.1 for local development
To try out Fred, you simply need to start the python backend:
The equivalent local command is:
Fred backend expects a valid OPENAI token in the OPENAI_API_TOKEN
environment variable, and a kubeconfig. Your kubeconfig can point to any kubernetes cluster including k3d, kind, minikube.
A great starting point is to try it out with kooker, or simply with a local minikube.
From there, Fred will start collecting and generating data and save it under ‘~/.fred/fred-backend-cache’ (as set in the resource/configuration-dev.yaml file).
If you do not want at all to interact with a remote or development K8 cluster nor perform some openai requests, get in touch with contributors to get a ready-to-use zip archive that you can simply unzip in ‘~/.fred/’. You will then work in offline mode.
You can use the LOG_LEVEL environment variable.
The Swagger UI is accessible at http://<host>:<port>/docs
. Follow the host and port of your configuration file.
You will have the documentation of the APIs and buttons to test it (Try it out
).
You will see something like:
Start the UI
Requirements
make
, curl
, gcc
, node
, nvm
, golang
and docker
are required to build and run the project on your laptop.
We recommand installing GoEnv, then use it to install golang 1.21
read the installation guide
For docker
read [installation guide for Ubuntu](https://docs.docker.com/engine/install/ubuntu/, https://docs.docker.com/engine/install/linux-postinstall/)
First you need to start the golang backend (checkout the reference guide to understand why we have this):
In another terminal.
Which is equivalent to:
Go to the indicated localhost url and use the UI with the credentials board/board.