Running Web Application

​

Prerequisites

• Node.js (LTS version)
• Yarn or NPM
• Docker
• Kodus API running
• LLM API Keys

​

Running the project

git clone https://github.com/kodustech/web.git
cd kodus-web
yarn dev:first-run

yarn install
yarn docker:start

​

Development workflow

​

Basic Local Development

1. Start services: yarn docker:start
2. Access web app: http://localhost:3000
3. Monitor logs: yarn docker:logs

​

Development with API Integration

1. Ensure API is running: The API should be accessible at http://localhost:3001
2. Verify JWT secrets match: Both web and API must use the same JWT secret
3. Test authentication: Try logging in to verify the connection

​

Service endpoints

• Development: http://localhost:3000
• API (external): http://localhost:3001

​

Troubleshooting

​

Common Issues

• Verify JWT secrets match between web and API
• Check if API is running and accessible
• Ensure NEXT_PUBLIC_API_URL is correct

• Clear Docker cache: docker system prune -a
• Rebuild: yarn docker:build --no-cache

• Verify .env file exists in project root
• Check for syntax errors in .env file
• Restart Docker services after .env changes

• Verify API is running on port 3001
• Check network connectivity between containers
• Verify API health endpoint: http://localhost:3001/health

​

Getting Help

1. Check the logs: yarn docker:logs
2. Verify API status: Ensure the Kodus API is running
3. Check environment variables: Ensure all required values are set
4. Review the API setup guide for backend configuration