This guide is for local development purposes. For production deployment, please refer to the Deploy Kodus guide.

​
Prerequisites

  • Node.js (LTS version)
  • Yarn or NPM
  • Docker
  • Orchestrator API running

​
Running the project

​
1. Clone the repository

git clone https://github.com/kodustech/kodus-web.git

​
2. Install dependencies

yarn install

​
3. Configure environment variables

cp .env.example .env

Change the environment variables in the .env file to match your local setup.

Checkout integration docs for more information about how to get the required credentials for each service.

​
4. Start the development environment

Launch the development server:

yarn docker:build
yarn docker:start

The application will be available at http://localhost:3000

​
5. Project structure

The project follows a clean, modular architecture:

├── src/                          # Main source code
│   ├── app/                     # App router pages and layouts
│   │   ├── ui/                 # UI components
│   │   └── features/           # Feature components
│   ├── hooks/                   # Custom React hooks
│   ├── lib/                     # Utility functions
│   ├── services/                # API services
│   └── types/                   # TypeScript types
│
├── public/                      # Static assets
│   ├── images/                 # Image assets
│   └── fonts/                  # Font files
│
├── styles/                      # Global styles
│   └── tailwind/              # Tailwind configuration
│
├── tests/                       # Test files
│   ├── unit/                   # Unit tests
│   ├── integration/            # Integration tests
│   └── e2e/                    # End-to-end tests
│
├── docker/                      # Docker configurations
│   ├── development/           # Development environment
│   └── production/            # Production environment
│
└── scripts/                     # Utility scripts
    └── setup/                 # Setup scripts

​
6. Tech Stack

The application is built with modern technologies:

  • Framework: Next.js 15
  • UI Libraries:
    • React 19
    • Radix UI Components
    • TailwindCSS
  • State Management: TanStack Query
  • Form Handling: React Hook Form + Zod
  • Authentication: NextAuth.js

​
7. Service endpoints

Access the application at:

  • Development: http://localhost:3000

Was this page helpful?

Suggest editsRaise issue