# 4NK Waste & Water - Simulator

Modular waste treatment infrastructure simulator for 4NK Waste & Water.

## Technology Stack

- **React** (latest version)
- **TypeScript**
- **React Router** (for routing)
- **Vite** (development server only, no build tool for production)
- **No state management library** (use React useState, useContext)

## Development

### Prerequisites

- Node.js (latest LTS version)
- npm, yarn, or pnpm

### Installation

```bash
npm install
# or
yarn install
# or
pnpm install
```

### Run Development Server

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```

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

**Important**: The application can only be accessed from localhost (127.0.0.1). Access from other hosts will be blocked.

## Project Structure

```
/src
  /components
    /base          # Base reusable components
    /composite     # Composite components
    /layout        # Layout components (Header, Sidebar)
    /shared        # Shared business logic components
  /pages           # Page components
  /hooks           # Custom React hooks
  /utils
    /calculations  # Calculation functions
    /formatters    # Data formatting
    /validators    # Validation functions
    /constants     # Constants and default values
  /types           # TypeScript type definitions
  /data            # Seed data (optional)
```

## Features

- Waste configuration
- Natural regulators configuration
- Services configuration
- Project management
- Treatment sites management
- Waste sites management
- Investors management
- Administrative procedures
- Yields calculation and display
- Business plan with 10-year projections
- Data export/import (JSON)

## Data Storage

All data is stored locally in the browser using localStorage. No backend is required.

- Storage key: `4nkwaste_simulator_data`
- User session: `4nkwaste_simulator_user`
- Data format: JSON

## Documentation

- **Specification**: `specification.md`
- **Data Schemas**: `data_schemas.md`
- **Formulas Reference**: `formulas_reference.md`
- **User Workflow**: `user_workflow.md`
- **Constants**: `constants.ts`

## License

Private project - 4NK Waste & Water