This project is a web application that facilitates collaborative intelligence using AI. It allows users to participate in Delphi-style rounds of questions and synthesizes the results.
frontend/: A React/Vite frontend application.backend/: A Python/FastAPI backend application.docker-compose.yml: For running the application with Docker.
There are two ways to run this project: using Docker or running the frontend and backend separately.
-
Create a
.envfile:In the root of the project, you will find a file named
.env.example. Make a copy of this file and name it.env.cp .env.example .env
-
Edit the
.envfile:Open the
.envfile and add your OpenRouter API key. The other variables should have sane defaults for local development.OPENROUTER_API_KEY="your-api-key"
-
Clone the repository:
git clone <repository-url> cd <repository-name>
-
Backend Setup (if not using Docker):
- Navigate to the
backenddirectory:cd backend - Create a virtual environment:
python3 -m venv .venv source .venv/bin/activate - Install the dependencies:
pip install -r requirements.txt
- Navigate to the
-
Frontend Setup (if not using Docker):
- Navigate to the
frontenddirectory:cd frontend - Install the dependencies:
npm install
- Navigate to the
With Docker:
- Make sure you have created the
.envfile as described in the configuration instructions. - Run the application using
docker-compose:The application will be available atdocker-compose up --build
http://localhost:3000.
Without Docker:
-
Run the backend:
- Navigate to the
backenddirectory and run the application:The backend will be running onuvicorn main:app --reload
http://localhost:8000.
- Navigate to the
-
Run the frontend:
- Navigate to the
frontenddirectory and run the application:The frontend will be running onnpm run dev
http://localhost:5173.
- Navigate to the
Admin User:
The admin user is created on application startup. You can configure the admin's email and password by creating a .env file in the backend directory.
backend/.env:
ADMIN_EMAIL=admin@example.com
ADMIN_PASSWORD=change-me-now
If you do not create a .env file, the application will use the default credentials:
- Email:
admin@example.com - Password:
change-me-now
Regular User:
To log in as a regular user, you must first register for an account on the registration page. Regular user accounts must use an email formatted as ..@... (e.g., something@something).
- Register a new user account.
- Log in to the application.
- As an admin, you can create new forms with questions.
- As a user, you can access the forms and submit your responses.
- The application will guide you through the rounds of the Delphi method.
- After each round, the AI will synthesize the results.