Learn Prompting (Uzbek Edition)

👋 Welcome to the Learn Prompting Uzbek Edition! This is a collaborative open-source project between Learn Prompting and HumblebeeAI to bring high-quality AI education to Uzbekistan.

---

📋 Overview

This project uses Docusaurus 2, a modern static website generator, to host the curriculum. It includes custom localization, a dedicated "About Collaboration" page, and alignment with national AI initiatives.

🚀 Installation & Setup

Prerequisites

• Node.js version 18.0 or above
• Docker (optional, for containerized deployment)

Local Development

1. Clone the repository:

   git clone https://github.com/humblebeeai/Learn_Prompting.git
   cd Learn_Prompting

2. Install dependencies:

   npm install

3. Start the development server:

   npm start

   The site will open at http://localhost:3000.

⚙️ Configuration

Copy the example environment file to .env to configure the application:

cp .env.example .env

Variable	Description	Default
LP_PORT	Port inside the container	80
LP_EXTERNAL_PORT	Port exposed to host	3000

🐳 Deployment (Docker)

To run the application in a Docker container (recommended for production):

1. Build and run:

   docker compose up --build -d

2. Verify: Access the site at http://localhost:3000. Health Check: http://localhost:3000/health.json

🩺 Health Check

The application exposes a health check endpoint at /health.json.

• URL: http://localhost:3000/health.json
• Response: {"status": "ok", "service": "learn-prompting", ...}

This is actively monitored by the Docker container's HEALTHCHECK instruction.

🛠 Troubleshooting

Docker Connection Failed:

Cannot connect to the Docker daemon... Ensure Docker Desktop is running.

Port Conflicts: If port 3000 is in use, modify LP_EXTERNAL_PORT in your .env file.

---

Pre-Deployment Checklist

Ensure all items are checked before deploying to production:

Project Structure & Organization

• Source code inside src/.
• Root contains Dockerfile, docker-compose.yml, .gitignore, .dockerignore.
• No hardcoded secrets.

Git Management

• .gitignore properly configured.
• No unnecessary files (build outputs, etc.) committed.

Dockerization

• Dockerfile uses multi-stage builds.
• docker-compose.yml configured.
• Image size optimized (using nginx:alpine).
• HEALTHCHECK implemented in Dockerfile.

Configuration

• No hardcoded configs.
• .env.example included with LP_ prefix.

Health Checks

• /health.json endpoint implemented.
• Docker container monitors health status.

Documentation

• README.md is comprehensive (this file).
• API/Service documentation included.