Choose Your Setup
Local Setup
Run Weam AI on your local machine for development, testing, or evaluation using Docker.
Minimum configuration: To ensure smooth execution, your system must meet these minimum requirements:
- RAM: 8 GB
- CPU: Quad-core (4 cores)
- Storage: 10GB free disk space
- Docker Desktop installed
- Git installed
- MacOS (Intel or Apple Silicon)
- Linux (Ubuntu 20.04+ recommended)
- Windows 10/11 with WSL2
Installation Steps
1
Clone Repository
Clone the project from GitHub and create your environment file:
2
Build and Start Services
Use the following commands to build and run the project:This will:
- Build all necessary Docker images
- Start backend, frontend, and supporting services
Ensure Docker and Docker Compose are installed before proceeding.
3
Verify Installation
The build process takes 5-10 minutes on the first run. Once complete, you should see:
4
Access Application
Open your browser and navigate to:
- Main Application: http://localhost:3000
- Registration: http://localhost:3000/register
- Login: http://localhost:3000/login
Service Ports
| Service | Port | URL |
|---|---|---|
| Frontend (Next.js) | 3000 | http://localhost:3000 |
| Backend (Node.js) | 4050 | http://localhost:4050 |
| Python API | 9089 | http://localhost:9089 |
| MongoDB | 27017 | Internal only |
| Redis | 6379 | Internal only |
| Qdrant (Vector DB) | 6333 | http://localhost:6333 |
| MinIO (File Storage) | 9000 | http://localhost:9000 |
Troubleshooting
Build Failures
Build Failures
Common causes:
- Docker doesn’t have enough memory allocated (8GB minimum)
- Ports 3000, 4050, and 9089 are already in use
- Docker daemon not running
- Increase Docker’s memory limit in Docker Desktop settings
- Stop other services using those ports:
sudo lsof -i :3000 - Start Docker Desktop and wait for it to fully load
Permission Errors
Permission Errors
On Linux:
- Add your user to the docker group:
sudo usermod -aG docker $USER - Restart your terminal session after adding to the docker group
- Try:
newgrp dockerto apply group changes immediately
- Ensure Docker Desktop has proper permissions
- Try running with
sudoif needed (not recommended for regular use)
Out of Memory
Out of Memory
Solutions:
- Close other applications to free up RAM
- Increase Docker’s memory limit in Docker Desktop settings
- Consider upgrading system RAM if consistently running into issues
- Use
docker system pruneto clean up unused containers and images
Key Reminders
- Always save
.shfiles withLFline endings on Windows - Use Ubuntu (WSL2) terminal for Windows development
- The first build takes longer due to image downloads and compilation
Advanced Configuration
Python Base Image Build (Optional)
Python Base Image Build (Optional)
The
pybase_docker build step is intentionally skipped to improve build efficiency and avoid unnecessary steps when working on frontend changes.Why It’s Skipped
| Reason | Description |
|---|---|
| Not Required for Frontend | The pybase_docker image is only used by backend services |
| Time Efficiency | Building Python images with heavy dependencies is time-consuming |
| No Dependency Overlap | Frontend and backend builds are fully isolated |
When to Re-enable
Uncomment the
pybase_docker build lines if:- You modified
requirements.txtdependencies - You’re doing a fresh/clean rebuild
- Backend services fail due to missing Python packages
Need help? Reach out via the GitHub issues or Discord Community for faster response.