### Example Build Command: Install Python Dependencies

Source: https://docs.appliku.com/docs/applications/build-settings

Use this command to install Python dependencies from a requirements file during the build phase.

```bash
pip install -r requirements.txt
```

--------------------------------

### Define Start Script in package.json

Source: https://docs.appliku.com/docs/deploy/nodejs

If your package.json has a 'start' script defined, 'npm start' is a simple way to launch your application. This example shows how to define the start script.

```json
{
  "scripts": {
    "start": "node server.js"
  }
}

```

--------------------------------

### Download Appliku LLM Guide with curl

Source: https://docs.appliku.com/docs/how-to/ai-coding-assistants

Download the Appliku LLM guide to your project root using `curl`. This allows you to reference it locally, for example, using '@APPLIKU.md' in your prompt.

```bash
curl https://appliku.com/llms.txt -o APPLIKU.md
```

--------------------------------

### Start Development Server

Source: https://docs.appliku.com/docs/deploy/static-sites

Run this command to start the local development server for previewing your static site.

```bash
npm start

```

--------------------------------

### Install uv and requirements.txt with Build Command

Source: https://docs.appliku.com/docs/how-to/use-uv-package-manager

Use this build command to install uv and then install project dependencies from requirements.txt. The --system flag installs packages into the container's environment.

```bash
pip install uv && uv pip install -r requirements.txt --system  

```

--------------------------------

### Complete Appliku YAML Configuration Example

Source: https://docs.appliku.com/docs/applications/appliku-yml

A comprehensive example demonstrating the integration of build settings, services, databases, volumes, cron jobs, and commands in a single appliku.yml file.

```yaml
build_settings:
  build_image: python-3.11-node-20.10
  build_command: npm run build
  container_port: 8000
  environment_variables:
    - name: DEBUG
      value: "false"
    - name: DATABASE_URL
      from_database:
        name: db
        property: connection_url
    - name: REDIS_URL
      from_database:
        name: redis
        property: connection_url
    - name: ALLOWED_HOSTS
      from_domains: true
    - name: SECRET_KEY
      source: manual

services:
  web:
    command: gunicorn project.wsgi --log-file -
    scale: 2
  worker:
    command: celery -A project worker -l info
    scale: 1
  release:
    command: python manage.py migrate

databases:
  db:
    type: postgresql_17
  redis:
    type: redis_7

volumes:
  media:
    target: /app/media/
    url: /media/
    environment_variable: MEDIA_ROOT

cronjobs:
  cleanup:
    schedule: "0 3 * * *"
    command: python manage.py cleanup_old_files

commands:
  - python manage.py show_urls
  - python manage.py validate_templates
  - python manage.py check
  - python manage.py send_queued_mail
```

--------------------------------

### Reference Appliku LLM Guide Inline with @

Source: https://docs.appliku.com/docs/how-to/ai-coding-assistants

Use the '@' symbol to attach the Appliku LLM guide URL inline within your prompt for context-aware assistance.

```bash
@https://appliku.com/llms.txt help me write an appliku.yml for this project
```

--------------------------------

### Install uv and pyproject.toml with Build Command

Source: https://docs.appliku.com/docs/how-to/use-uv-package-manager

Use this build command to install uv and then install the project from pyproject.toml. The --system flag installs packages into the container's environment.

```bash
pip install uv && uv pip install . --system  

```

--------------------------------

### Configure Next.js Build and Start Commands in Appliku

Source: https://docs.appliku.com/docs/deploy/nextjs

Sets the Base Docker Image to 'Node 20 Yarn', the build command to 'yarn build', and the start command for the 'web' process to 'npm run start' in Appliku settings.

```bash
yarn build
```

```bash
npm run start
```

--------------------------------

### Install and Use Appliku CLI/SDK

Source: https://docs.appliku.com/docs/reference/api-overview

Install the Appliku CLI/SDK using pip. Authenticate your CLI/SDK using 'appliku auth login'. List applications using 'appliku apps list'.

```bash
# Install the CLI/SDK
pip install appliku

# Authenticate
appliku auth login

# List applications
appliku apps list
```

--------------------------------

### Example Configuration in appliku.yml

Source: https://docs.appliku.com/docs/applications/build-settings

All build settings can be defined in the `appliku.yml` file for automatic application on deploy.

```yaml
build:
  image: python:3.9
  command: pip install -r requirements.txt
  dockerfile_path: docker/Dockerfile
  build_context: .
  port: 8000
  skip_release_command: true
  expose_web_port: true
  allow_placement_on_manager_nodes: false
  static_site:
    enabled: true
    output_dir: build/
```

--------------------------------

### Reference Downloaded Appliku LLM Guide

Source: https://docs.appliku.com/docs/how-to/ai-coding-assistants

After downloading the Appliku LLM guide (e.g., as APPLIKU.md), reference it in your prompt using '@APPLIKU.md' for assistance with Appliku deployments.

```bash
Help me deploy this app to Appliku, see @APPLIKU.md
```

--------------------------------

### Install Rails and Create New Project

Source: https://docs.appliku.com/docs/deploy/rails

Installs the Rails gem and generates a new Rails application. Assumes Ruby 4.0 or higher is installed.

```bash
gem install rails
rails new myapp
cd myapp
```

--------------------------------

### Reference Appliku LLM Guide URL Directly

Source: https://docs.appliku.com/docs/how-to/ai-coding-assistants

Paste the Appliku LLM guide URL directly into your prompt. Many AI tools will automatically fetch and read its content to assist with Appliku deployments.

```bash
Help me deploy this Django app to Appliku. 
Context: https://appliku.com/llms.txt
```

--------------------------------

### One-shot Fetch Appliku LLM Guide

Source: https://docs.appliku.com/docs/how-to/ai-coding-assistants

Instruct the AI to fetch the Appliku LLM guide before assisting with your request. This is useful for one-time or ad-hoc assistance.

```bash
Fetch https://appliku.com/llms.txt and then help me create an appliku.yml for my Node.js app
```

--------------------------------

### Example JetBrains Space Git URL with Credentials

Source: https://docs.appliku.com/docs/how-to/jetbrains-space

An example of a complete Git URL including a specific extension app name and a redacted permanent token.

```text
https://applikudeploy:eyJhb9...zdcenc@git.jetbrains.space/appliku/main/sometest.git  
```

--------------------------------

### Install uv (Windows PowerShell)

Source: https://docs.appliku.com/docs/cli-sdk

Installs uv, the recommended package manager for the Appliku CLI, on Windows systems using PowerShell.

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

--------------------------------

### Database Provisioning Example

Source: https://docs.appliku.com/docs/reference/appliku-yml-reference

Configures various database services like PostgreSQL, Redis, and RabbitMQ, specifying their types.

```yaml
databases:
  db:
    type: postgresql_17
  cache:
    type: redis_7
  broker:
    type: rabbitmq
```

--------------------------------

### Start a Datastore

Source: https://docs.appliku.com/docs/cli-sdk/python-sdk

Start a stopped datastore associated with an application.

```python
client.datastores.start("my-team", app_id=42, datastore_id=5)
```

--------------------------------

### Rails Startup Command

Source: https://docs.appliku.com/docs/troubleshooting/deployment-failures

Example of a Rails server startup command, specifying the bind address and port.

```ruby
rails server -b 0.0.0.0 -p 3000
```

--------------------------------

### Install Appliku with pip

Source: https://docs.appliku.com/docs/cli-sdk

Installs the Appliku package using pip as an alternative to uv.

```bash
pip install appliku
```

--------------------------------

### Redis Connection URL Example

Source: https://docs.appliku.com/docs/reference/env-vars-reference

Example of a connection URL for a provisioned Redis instance.

```shell
redis://host:port/0  
```

--------------------------------

### Install Appliku CLI with uv

Source: https://docs.appliku.com/docs/cli-sdk

Installs the Appliku CLI as a standalone tool, making it globally available as the 'appliku' command.

```bash
uv tool install appliku
```

--------------------------------

### Install and Use Latest Node.js

Source: https://docs.appliku.com/docs/deploy/nextjs

Installs the latest Node.js version using NVM and activates it for the current session.

```bash
nvm install node  
nvm use node  
```

--------------------------------

### Permanently Add Appliku LLM Guide to .cursorrules

Source: https://docs.appliku.com/docs/how-to/ai-coding-assistants

Add the Appliku LLM guide URL to your `.cursorrules` file to ensure it's always included in the context for Appliku-related questions.

```bash
Always refer to https://appliku.com/llms.txt when helping with Appliku deployments.
```

--------------------------------

### Node.js/Express Startup Command

Source: https://docs.appliku.com/docs/troubleshooting/deployment-failures

Example of a Node.js/Express startup command, using the PORT environment variable or a default.

```javascript
app.listen(process.env.PORT || 3000)
```

--------------------------------

### Add Appliku LLM Guide to CLAUDE.md

Source: https://docs.appliku.com/docs/how-to/ai-coding-assistants

Add the reference to the downloaded Appliku LLM guide (e.g., '@APPLIKU.md') to your `CLAUDE.md` file to ensure it's always loaded for Appliku deployment help.

```bash
For Appliku deployment help, see @APPLIKU.md
```

--------------------------------

### Install uv and dependencies in Dockerfile

Source: https://docs.appliku.com/docs/how-to/use-uv-package-manager

Integrate uv into your Dockerfile by copying the uv binary and then using it to install dependencies from requirements.txt. The --system flag is used for container environment installation.

```dockerfile
FROM python:3.12-slim  

# Install uv  
COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv  

WORKDIR /app  

# Copy dependency files first for better caching  
COPY requirements.txt .  

# Install dependencies with uv  
RUN uv pip install -r requirements.txt --system  

# Copy application code  
COPY . .  

# Collect static files  
RUN python manage.py collectstatic --noinput  

CMD ["gunicorn", "myproject.wsgi", "--bind", "0.0.0.0:8000"]  

```

--------------------------------

### Install uv (macOS/Linux)

Source: https://docs.appliku.com/docs/cli-sdk

Installs uv, the recommended package manager for the Appliku CLI, on macOS and Linux systems using curl.

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

--------------------------------

### Example TCP Server

Source: https://docs.appliku.com/docs/how-to/expose-non-http-port

A Python example demonstrating a simple TCP server listening on a custom port. Ensure your application listens on the desired port.

```python
import socket

server = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
server.bind(("0.0.0.0", 1883))
server.listen(5)

```

--------------------------------

### Verify Appliku CLI Installation

Source: https://docs.appliku.com/docs/cli-sdk

Confirms the Appliku CLI installation by displaying its help information.

```bash
appliku --help
```

--------------------------------

### Install Appliku SDK with uv

Source: https://docs.appliku.com/docs/cli-sdk

Adds the Appliku SDK as a dependency to a Python project using uv.

```bash
uv add appliku
```

--------------------------------

### Allowed Hosts Example Value

Source: https://docs.appliku.com/docs/reference/env-vars-reference

Example value for the ALLOWED_HOSTS environment variable, which is a comma-separated list of configured domains.

```shell
myapp.applikuapp.com,www.example.com,example.com  
```

--------------------------------

### Example Database Migration Command

Source: https://docs.appliku.com/docs/deploy

A common use case for the release command is to run database migrations. This example shows a typical Django migration command.

```python
python manage.py migrate

```

--------------------------------

### Getting Help for CLI Commands

Source: https://docs.appliku.com/docs/cli-sdk/cli-reference

Use the --help flag on any command to get detailed information about its options and usage.

```bash
appliku apps --help
```

```bash
appliku apps logs --help
```

--------------------------------

### Run Database Migrations with Alembic

Source: https://docs.appliku.com/docs/deploy/python-generic

Example command for a `release` process to upgrade database migrations using Alembic.

```bash
alembic upgrade head
```

--------------------------------

### Django/Gunicorn Startup Command

Source: https://docs.appliku.com/docs/troubleshooting/deployment-failures

Example of a Gunicorn startup command for Django applications, ensuring it binds to the correct port.

```bash
gunicorn project.wsgi --bind 0.0.0.0:8000
```

--------------------------------

### Example Application Services

Source: https://docs.appliku.com/docs/applications/appliku-yml

Defines the services that will run for your application, including their commands, scaling, and resource limits.

```yaml
services:
  web:
    command: gunicorn project.wsgi --log-file -
    scale: 1
    mode: replicated
    resources_limits_memory: 512M
    resources_limits_cpus: "0.5"

  worker:
    command: celery -A project worker -l info
    scale: 2
    mode: replicated

  release:
    command: bash release.sh
```

--------------------------------

### Run Next.js Development Server

Source: https://docs.appliku.com/docs/deploy/nextjs

Starts the Next.js development server to view your application locally.

```bash
npm run dev  
```

--------------------------------

### Run Database Migrations with Flask

Source: https://docs.appliku.com/docs/deploy/python-generic

Example command for a `release` process to upgrade database migrations for a Flask application.

```bash
flask db upgrade
```

--------------------------------

### Example Database Services

Source: https://docs.appliku.com/docs/applications/appliku-yml

Configures provisioned database services for your application, specifying the type for each named database.

```yaml
databases:
  db:
    type: postgresql_17
  redis:
    type: redis_7
```

--------------------------------

### Install Django Storages and Boto3

Source: https://docs.appliku.com/docs/how-to/connect-to-s3

Add these dependencies to your requirements.txt file to enable S3 integration.

```text
django-storages
 bota3
```

--------------------------------

### Role Hierarchy Example

Source: https://docs.appliku.com/docs/team-management/members-and-roles

Illustrates the hierarchical relationship between permission roles in Appliku.

```text
Owner  >  Admin  >  Developer  
```

--------------------------------

### Example Dockerfile Path Configuration

Source: https://docs.appliku.com/docs/applications/build-settings

Specify a relative path to your Dockerfile if it's not located in the root of your repository.

```text
docker/Dockerfile
```

--------------------------------

### Python 3.12 Dockerfile

Source: https://docs.appliku.com/docs/reference/predefined-dockerfiles

A Dockerfile template for Python 3.12. It includes system package installation, pip upgrades, dependency installation, and user setup.

```dockerfile
FROM python:3.12.3-bullseye
SHELL ["/bin/bash", "-c"]
ENV PIP_NO_CACHE_DIR off
ENV PIP_DISABLE_PIP_VERSION_CHECK on
ENV PYTHONUNBUFFERED 1
ENV PYTHONDONTWRITEBYTECODE 0
RUN apt-get update \
 && apt-get install -y --force-yes \
 nano python3-pip gettext chrpath libssl-dev libxft-dev \
 libfreetype6 libfreetype6-dev  libfontconfig1 libfontconfig1-dev\
 && rm -rf /var/lib/apt/lists/*
RUN pip install --upgrade pip && pip install --upgrade setuptools && pip install gunicorn
WORKDIR /code/
COPY ./code/requirements.txt /code/
RUN pip install -r requirements.txt
COPY ./code/ /code/
COPY ./env/ /env/
RUN source /env/envs_export.sh && if [ -n "$BUILD_COMMAND" ]; then eval $BUILD_COMMAND; fi
RUN source /env/envs_export.sh && export && if [ -f "manage.py" ]; then if [ "$DISABLE_COLLECTSTATIC" == "1" ]; then echo "collect static disabled"; else echo "Found manage.py, running collectstatic" && python manage.py collectstatic --noinput; fi;  else echo "No manage.py found. Skipping collectstatic."; fi;
RUN useradd -ms /bin/bash code
USER code
```

--------------------------------

### Node 22 NPM Dockerfile

Source: https://docs.appliku.com/docs/reference/predefined-dockerfiles

Dockerfile for Node.js 22 with NPM package installation and environment variable setup.

```docker
FROM node:22-alpine  
RUN apk add --no-cache libc6-compat build-base python3  
WORKDIR /code  
COPY code/package*.json  ./  
RUN npm install  
COPY code/. .  
COPY ./code/ /code/  
COPY ./env/ /env/  
RUN source /env/envs_export.sh && if [ -n "$BUILD_COMMAND" ]; then eval $BUILD_COMMAND; fi  
USER node  

```

--------------------------------

### Node 24 NPM Dockerfile

Source: https://docs.appliku.com/docs/reference/predefined-dockerfiles

Dockerfile for Node.js 24 with NPM package installation and environment variable setup.

```docker
FROM node:24-alpine  
RUN apk add --no-cache libc6-compat build-base python3  
WORKDIR /code  
COPY code/package*.json  ./  
RUN npm install  
COPY code/. .  
COPY ./code/ /code/  
COPY ./env/ /env/  
RUN source /env/envs_export.sh && if [ -n "$BUILD_COMMAND" ]; then eval $BUILD_COMMAND; fi  
USER node  

```

--------------------------------

### Export Poetry Dependencies to requirements.txt

Source: https://docs.appliku.com/docs/deploy/python-generic

Example command to export dependencies from a Poetry project to a `requirements.txt` file.

```bash
# Poetry
poetry export -f requirements.txt -o requirements.txt
```

--------------------------------

### Node 25 NPM Dockerfile

Source: https://docs.appliku.com/docs/reference/predefined-dockerfiles

Dockerfile for Node.js 25 with NPM package installation and environment variable setup.

```docker
FROM node:25-alpine  
RUN apk add --no-cache libc6-compat build-base python3  
WORKDIR /code  
COPY code/package*.json  ./  
RUN npm install  
COPY code/. .  
COPY ./code/ /code/  
COPY ./env/ /env/  
RUN source /env/envs_export.sh && if [ -n "$BUILD_COMMAND" ]; then eval $BUILD_COMMAND; fi  
USER node  

```

--------------------------------

### Remove Existing Docker Installation

Source: https://docs.appliku.com/docs/troubleshooting/server-setup-failures

If Docker is already installed on the server, it can conflict with Appliku's setup. This command removes existing Docker packages and associated data. Warning: This will delete all existing containers, images, and volumes.

```bash
sudo apt-get purge docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin  
sudo rm -rf /var/lib/docker  
sudo rm -rf /var/lib/containerd  
```

--------------------------------

### PostgreSQL pgvector Extension and Table Setup

Source: https://docs.appliku.com/docs/databases/specialized-postgres

Enable the pgvector extension and create a table with a vector column for storing embeddings. Example uses OpenAI ada-002 dimension.

```sql
-- Enable the extension
CREATE EXTENSION IF NOT EXISTS vector;

-- Create a table with a vector column
CREATE TABLE documents (
    id SERIAL PRIMARY KEY,
    content TEXT,
    embedding vector(1536)  -- OpenAI ada-002 dimension
);

```

--------------------------------

### Python 3.12 + Node 20 NPM Dockerfile

Source: https://docs.appliku.com/docs/reference/predefined-dockerfiles

A Dockerfile for Python 3.12 and Node.js 20, including NPM and Yarn setup. It installs system packages, Node.js via NVM, and Python dependencies.

```dockerfile
FROM python:3.12.3-bullseye
SHELL ["/bin/bash", "-c"]
ENV PIP_NO_CACHE_DIR off
ENV PIP_DISABLE_PIP_VERSION_CHECK on
ENV PYTHONUNBUFFERED 1
ENV PYTHONDONTWRITEBYTECODE 0
RUN apt-get update \
 && apt-get install -y --force-yes \
 nano python3-pip gettext chrpath libssl-dev libxft-dev \
 libfreetype6 libfreetype6-dev  libfontconfig1 libfontconfig1-dev\
 && rm -rf /var/lib/apt/lists/*
ENV NODE_VERSION=20.10.0
ENV NVM_DIR=/root/.nvm
RUN apt install -y curl
RUN curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.39.7/install.sh | bash
RUN . "$NVM_DIR/nvm.sh" && nvm install ${NODE_VERSION}
RUN . "$NVM_DIR/nvm.sh" && nvm use v${NODE_VERSION}
RUN . "$NVM_DIR/nvm.sh" && nvm alias default v${NODE_VERSION}
ENV PATH="/root/.nvm/versions/node/v${NODE_VERSION}/bin/:${PATH}"
RUN node --version
RUN npm --version
RUN npm install --global yarn@1.22.21
RUN pip install --upgrade pip && pip install --upgrade setuptools && pip install gunicorn
WORKDIR /code/
COPY ./code/requirements.txt /code/
RUN pip install -r requirements.txt
COPY ./code/ /code/
COPY ./env/ /env/
RUN source /env/envs_export.sh && if [ -n "$BUILD_COMMAND" ]; then eval $BUILD_COMMAND; fi
RUN source /env/envs_export.sh && export && if [ -f "manage.py" ]; then if [ "$DISABLE_COLLECTSTATIC" == "1" ]; then echo "collect static disabled"; else echo "Found manage.py, running collectstatic" && python manage.py collectstatic --noinput; fi;  else echo "No manage.py found. Skipping collectstatic."; fi;
RUN useradd -ms /bin/bash code
USER code
```

--------------------------------

### Recommended Cluster Architectures

Source: https://docs.appliku.com/docs/clusters/cluster-limitations

Illustrates recommended setups for single-node and multi-node clusters, including dedicated database nodes and build servers.

```text
Single-node cluster:  
Cluster Leader (also DB-labeled)  -->  Swarm manager + Nginx + databases + apps  
  
Multi-node cluster, dedicated DB nodes:  
Standalone Server (optional)  -->  Build server / external databases  
Cluster Leader               -->  Swarm manager + Nginx load balancer  
Cluster Worker (DB-labeled)  -->  Database containers (pinned)  
Cluster Worker(s)            -->  Application containers  
```

--------------------------------

### Verify uv Installation

Source: https://docs.appliku.com/docs/cli-sdk

Checks if the uv installation was successful by displaying its version.

```bash
uv --version
```

--------------------------------

### Install WhiteNoise using pip

Source: https://docs.appliku.com/docs/how-to/django-static-files

Install the WhiteNoise package directly using pip.

```bash
pip install whitenoise  
```

--------------------------------

### Install NVM

Source: https://docs.appliku.com/docs/deploy/nextjs

Installs Node Version Manager (NVM) to manage Node.js versions.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash  
```

--------------------------------

### Initialize Django Project and Add Dependencies

Source: https://docs.appliku.com/docs/deploy/django

Creates a new Django project directory, initializes it with uv, and adds essential packages like Django, django-environ, gunicorn, psycopg, whitenoise, and Pillow. It then exports dependencies to requirements.txt for deployment.

```bash
mkdir mydjangoproject
cd mydjangoproject
uv init --bare
uv add Django==6.0.3 django-environ==0.13.0 gunicorn==25.1.0 "psycopg[binary]==3.3.3" whitenoise==6.12.0 Pillow
uv export --no-hashes > requirements.txt
uv run django-admin startproject project .
```

--------------------------------

### Install Streamlit

Source: https://docs.appliku.com/docs/deploy/streamlit

Installs the Streamlit library using pip within the activated virtual environment.

```bash
pip install streamlit

```

--------------------------------

### Heroku Procfile Example

Source: https://docs.appliku.com/docs/deploy/heroku-migration

Example of a Procfile defining web, worker, and release processes for a Heroku application.

```Procfile
web: gunicorn myapp.wsgi --log-file -
worker: celery -A myapp worker --loglevel=info
release: python manage.py migrate  

```

--------------------------------

### Initialize Appliku Client

Source: https://docs.appliku.com/docs/cli-sdk/python-sdk

Create an Appliku client instance using the saved token from `appliku login` or the APPLIKU_TOKEN environment variable.

```python
from appliku import Appliku

client = Appliku()
```

--------------------------------

### Volume Definition Example

Source: https://docs.appliku.com/docs/reference/appliku-yml-reference

Sets up persistent storage volumes, defining their mount targets, optional URLs for web access, and environment variable names.

```yaml
volumes:
  media:
    target: /app/media/
    url: /media/
    environment_variable: MEDIA_ROOT
  data:
    target: /app/data/
    environment_variable: DATA_PATH
```

--------------------------------

### Media File Settings

Source: https://docs.appliku.com/docs/deploy/django

Configure root directory and URL for media files. Ensure a persistent volume is added in Appliku settings for proper functionality.

```python
MEDIA_ROOT = env("MEDIA_ROOT", default=BASE_DIR / "media")  
MEDIA_URL = env("MEDIA_PATH", default="/media/")  
```

--------------------------------

### Initialize Git Repository and Commit

Source: https://docs.appliku.com/docs/deploy/static-sites

Initialize a Git repository and commit your project files for version control.

```bash
git init
git add .
git commit -m "Initial commit"

```

--------------------------------

### Example Static Site Output Directory

Source: https://docs.appliku.com/docs/applications/build-settings

Specify the directory containing your built static files when the 'Static Site' option is enabled.

```text
build/
```

--------------------------------

### Example Build Context Configuration

Source: https://docs.appliku.com/docs/applications/build-settings

Define the directory to be used as the Docker build context. '.' typically refers to the repository root.

```text
.
```

--------------------------------

### Example Response for Domain Status

Source: https://docs.appliku.com/docs/how-to/automate-custom-domains

This is an example of the JSON response when checking the status of custom domains. Note that the 'logs' field is internal.

```json
[
  {
    "id": 18,
    "domain": "mycustomdomainname.com",
    "a_records": ["3.126.219.48"],
    "aaaa_records": [],
    "deployment_status": "2",
    "deployment_status_text": "Deployed",
    "logs": "Deploying domain configuration\nDeployment successful\n"
  }
]
```

--------------------------------

### Example .env File Format

Source: https://docs.appliku.com/docs/deploy/from-dockerfile

An example of environment variables stored in the dotenv format within the .env file. This file is used in docker-compose.yml.

```dotenv
DJANGO_COLLECTSTATIC=1
DJANGO_DEBUG=False
 DJANGO_ALLOWED_HOSTS=something.applikuapp.com

```

--------------------------------

### Initialize Git Repository and Push to GitHub

Source: https://docs.appliku.com/docs/deploy/streamlit

Initializes a Git repository, adds all files, commits them, sets the remote origin, and pushes to GitHub.

```bash
git init
git add .
git commit -m 'Initial commit'
git remote add origin git@github.com:your-username/your-repo.git
git push -u origin master

```

--------------------------------

### Python 3.13 Dockerfile

Source: https://docs.appliku.com/docs/reference/predefined-dockerfiles

A Dockerfile template for Python 3.13. It installs necessary packages, upgrades pip, installs project dependencies, and sets up a non-root user.

```dockerfile
FROM python:3.13.0-bullseye
SHELL ["/bin/bash", "-c"]
ENV PIP_NO_CACHE_DIR off
ENV PIP_DISABLE_PIP_VERSION_CHECK on
ENV PYTHONUNBUFFERED 1
ENV PYTHONDONTWRITEBYTECODE 0
RUN apt-get update \
 && apt-get install -y --force-yes \
 nano python3-pip gettext chrpath libssl-dev libxft-dev \
 libfreetype6 libfreetype6-dev  libfontconfig1 libfontconfig1-dev\
 && rm -rf /var/lib/apt/lists/*
RUN pip install --upgrade pip && pip install --upgrade setuptools && pip install gunicorn
WORKDIR /code/
COPY ./code/requirements.txt /code/
RUN pip install -r requirements.txt
COPY ./code/ /code/
COPY ./env/ /env/
RUN source /env/envs_export.sh && if [ -n "$BUILD_COMMAND" ]; then eval $BUILD_COMMAND; fi
RUN source /env/envs_export.sh && if [ -f "manage.py" ]; then if [ "$DISABLE_COLLECTSTATIC" == "1" ]; then echo "collect static disabled"; else echo "Found manage.py, running collectstatic" && python manage.py collectstatic --noinput; fi;  else echo "No manage.py found. Skipping collectstatic."; fi;
RUN useradd -ms /bin/bash code
USER code
```

--------------------------------

### Build Static Site

Source: https://docs.appliku.com/docs/deploy/static-sites

Execute this command to generate the production-ready static files for your website.

```bash
npm run build

```

--------------------------------

### Ruby 3.4.1 Dockerfile

Source: https://docs.appliku.com/docs/reference/predefined-dockerfiles

This Dockerfile configures a Ruby 3.4.1 environment using a slim base image. It installs build essentials, Git, and Node.js, then installs Ruby gems.

```docker
FROM ruby:3.4.1-slim
SHELL ["/bin/bash", "-c"]
RUN apt-get update && apt-get install -y \
    build-essential \
    git \
    nodejs \
    && rm -rf /var/lib/apt/lists/*
WORKDIR /code/
COPY ./code/Gemfile* /code/
RUN bundle install
COPY ./code/ /code/
COPY ./env/ /env/
RUN source /env/envs_export.sh && if [ -n "$BUILD_COMMAND" ]; then eval $BUILD_COMMAND; fi

```

--------------------------------

### Install Appliku Claude Code Skill

Source: https://docs.appliku.com/docs/cli-sdk

Installs the Appliku skill for Claude Code, enabling the AI agent to understand the Appliku CLI and SDK without manual context.

```bash
npx skills add appliku/skill -g -a claude-code
```

--------------------------------

### Example Build Command: Compile Node.js Assets

Source: https://docs.appliku.com/docs/applications/build-settings

Use this command to compile frontend assets for a Node.js application during the build phase.

```bash
npm run build
```

--------------------------------

### Node 20 NPM Dockerfile

Source: https://docs.appliku.com/docs/reference/predefined-dockerfiles

This Dockerfile sets up a Node.js 20 environment using an Alpine base image. It installs necessary build tools and dependencies, then installs NPM packages.

```docker
FROM node:20-alpine
RUN apk add --no-cache libc6-compat build-base python3
WORKDIR /code
COPY code/package*.json  .
RUN npm install
COPY code/. .
COPY ./code/ /code/
COPY ./env/ /env/
RUN source /env/envs_export.sh && if [ -n "$BUILD_COMMAND" ]; then eval $BUILD_COMMAND; fi

```

--------------------------------

### Example envs_export.sh File Format

Source: https://docs.appliku.com/docs/deploy/from-dockerfile

An example of environment variables in the export format within the envs_export.sh file. This file may be used in a Dockerfile if environment variables are needed during the build process.

```bash
export DJANGO_COLLECTSTATIC="1"
export DJANGO_DEBUG="False"
export DJANGO_ALLOWED_HOSTS="something.applikuapp.com"

```

--------------------------------

### Example Application Directory Structure

Source: https://docs.appliku.com/docs/deploy/from-dockerfile

This shows the typical directory structure within an application's directory on the server, including the Dockerfile, application code, docker-compose.yml, and environment variable files.

```bash
# ls /home/app/someapp
Dockerfile  
code  
docker-compose.yml  
env/dot.env  
env/envs_export.sh  

```

--------------------------------

### Python 3.11 with Chrome Browser Dockerfile

Source: https://docs.appliku.com/docs/reference/predefined-dockerfiles

Use this Dockerfile to set up a Python 3.11 environment with Chrome Browser and ChromeDriver installed. It includes necessary system packages and installs Python dependencies from requirements.txt.

```docker
FROM python:3.11.10-bullseye  
SHELL ["/bin/bash", "-c"]  
ENV PIP_NO_CACHE_DIR off  
ENV PIP_DISABLE_PIP_VERSION_CHECK on  
ENV PYTHONUNBUFFERED 1  
ENV PYTHONDONTWRITEBYTECODE 0  
  
  
ARG CHROME_VERSION=125.0.6422.141-1  
ARG CHROME_DRIVER_VERSION=125.0.6422.141  
  
RUN apt-get update && apt-get install -y \
	wget \
    unzip  

RUN mkdir -p /usr/local/tmp \
	&& cd /usr/local/tmp \
	&& wget http://dl.google.com/linux/deb/pool/main/g/google-chrome-stable/google-chrome-stable_"$CHROME_VERSION"_amd64.deb \
    && apt-get install -y ./google-chrome-stable_"$CHROME_VERSION"_amd64.deb \
 	&& wget https://storage.googleapis.com/chrome-for-testing-public/"$CHROME_DRIVER_VERSION"/linux64/chromedriver-linux64.zip \
    && unzip chromedriver-linux64.zip \
    && mv chromedriver-linux64/chromedriver /usr/bin/chromedriver \
    && chmod +x /usr/bin/chromedriver  
  
  
RUN apt-get update \
 && apt-get install -y --force-yes \
 nano python3-pip gettext chrpath libssl-dev libxft-dev \
 libfreetype6 libfreetype6-dev  libfontconfig1 libfontconfig1-dev\
 && rm -rf /var/lib/apt/lists/*  
RUN pip install --upgrade pip && pip install --upgrade setuptools && pip install gunicorn  
WORKDIR /code/  
COPY ./code/requirements.txt /code/  
RUN pip install -r requirements.txt  
COPY ./code/ /code/  
COPY ./env/ /env/  
RUN source /env/envs_export.sh && if [ -n "$BUILD_COMMAND" ]; then eval $BUILD_COMMAND; fi  
RUN source /env/envs_export.sh && export && if [ -f "manage.py" ]; then if [ "$DISABLE_COLLECTSTATIC" == "1" ]; then echo "collect static disabled"; else echo "Found manage.py, running collectstatic" && python manage.py collectstatic --noinput; fi;  else echo "No manage.py found. Skipping collectstatic."; fi;  
RUN useradd -ms /bin/bash code  
USER code  

```

--------------------------------

### Initialize Docusaurus Project

Source: https://docs.appliku.com/docs/deploy/static-sites

Use this command to create a new Docusaurus project. Choose JavaScript or TypeScript when prompted.

```bash
npx create-docusaurus@latest docusaurustutorial classic  
cd docusaurustutorial  
```

--------------------------------

### Create a Datastore

Source: https://docs.appliku.com/docs/cli-sdk/python-sdk

Create a new datastore for an application, specifying its name and kind (e.g., 'postgresql').

```python
client.datastores.create("my-team", app_id=42, name="mydb", kind="postgresql")
```

--------------------------------

### Create requirements.txt

Source: https://docs.appliku.com/docs/deploy/streamlit

Specifies the Streamlit version to be installed in the production environment.

```text
streamlit==1.34.0

```