### Download Frappe Helpdesk Installation Script

Source: https://docs.frappe.io/helpdesk

Use this command to download the installation script for Frappe Helpdesk. This is the first step for a production setup.

```bash
wget https://frappe.io/easy-install.py
```

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

### Deploy Frappe Helpdesk Production Setup

Source: https://docs.frappe.io/helpdesk/canned-response

Execute this command to install Frappe Helpdesk for production. Remember to replace placeholder values for email and domain name.

```bash
python3 ./easy-install.py deploy \
    --project=helpdesk_prod_setup \
    --email=your_email.example.com \
    --image=ghcr.io/frappe/helpdesk \
    --version=stable \
    --app=helpdesk \
    --sitename subdomain.domain.tld

```

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

### Frontend Development Setup

Source: https://docs.frappe.io/crm/introduction/installation

Commands to install dependencies and start the Vite development server for frontend development of Frappe CRM.

```bash
yarn install
yarn dev

```

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

### Download Easy Install Script

Source: https://docs.frappe.io/crm/introduction/installation

Use this command to download the easy-install script for a production setup.

```bash
wget https://frappe.io/easy-install.py

```

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

### Local Setup with Bench

Source: https://docs.frappe.io/crm/introduction/installation

Commands to install and set up Frappe CRM locally using the Bench CLI.

```bash
$ bench get-app crm
$ bench new-site sitename.localhost --install-app crm
$ bench browse sitename.localhost --user Administrator

```

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

### Setup Python Environment

Source: https://docs.frappe.io/learning/falcon-self-hosting-guide

Create a Python virtual environment, activate it, and install project dependencies including uvicorn for WebSocket support.

```bash
python3 -m venv env
source env/bin/activate
pip install --upgrade pip
pip install -r dev-requirements.txt
```

```bash
pip install 'uvicorn[standard]'
```

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

### Install Local App into Bench

Source: https://docs.frappe.io/cloud/common-issues/debugging-app-installs-locally

Install the locally cloned app into your new bench using the `bench get-app` command with a file path. This simulates the Frappe Cloud installation process.

```bash
bench get-app file:///some/path/app # In /some/path/test-install

```

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

### Install Wiki App on Bench

Source: https://docs.frappe.io/wiki-v2/install-locally

Use these commands to fetch the Wiki app from its GitHub repository and then install it on your Frappe site.

```bash
# get-app

$ bench get-app https://github.com/frappe/wiki

# install on site

$ bench --site sitename install-app wiki
```

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

### Install Frappe Helpdesk on Existing ERPNext Site

Source: https://docs.frappe.io/helpdesk

Commands to install Frappe Helpdesk as an app on an existing self-hosted ERPNext site. This involves fetching the app and then installing it for a specific site.

```bash
bench get-app helpdesk --branch main
bench --site your_site_name install-app helpdesk
```

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

### Install Go for Press App Build (M-Series Mac)

Source: https://docs.frappe.io/cloud/local-fc-setup

If encountering 'go' errors during Press app installation on M-series Macs, install Go and configure the environment variable.

```bash
brew install go
go env -w GO111MODULE=off
```

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

### Setup Development Requirements

Source: https://docs.frappe.io/cloud/local-fc-setup

Install development-specific Python dependencies for Frappe using the `bench setup requirements --dev` command. This ensures all necessary tools for development and testing are available.

```bash
bench setup requirements --dev

```

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

### Deploy Frappe Learning (Production)

Source: https://docs.frappe.io/learning/get-started/installation

Run the deployment command to set up a production-ready Frappe Learning instance. Ensure you replace placeholder values for email and domain.

```bash
python3 ./easy-install.py deploy \
    --project=learning_prod_setup \
    --email=your_email.example.com \
    --image=ghcr.io/frappe/lms \
    --version=stable \
    --app=lms \
    --sitename subdomain.domain.tld

```

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

### Install Frappe Insights on Existing ERPNext Site

Source: https://docs.frappe.io/insights/get-started/installation

Commands to get and install Frappe Insights as an app on an existing self-hosted ERPNext site. Ensure you replace 'your_site_name' with your actual site name.

```bash
bench get-app insights --branch version-3
bench --site your_site_name install-app insights

```

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

### Download Docker Compose and Init Script

Source: https://docs.frappe.io/learning/get-started/installation

Download the necessary configuration files for setting up Frappe Learning using Docker.

```bash
mkdir frappe-learning
cd frappe-learning

# Download the docker-compose file
wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/lms/develop/docker/docker-compose.yml

# Download the setup script
wget -O init.sh https://raw.githubusercontent.com/frappe/lms/develop/docker/init.sh

```

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

### Vue Component Example

Source: https://docs.frappe.io/framework/using-vue-inside-a-desk-page

A simple Vue 3 component using the Composition API with `<script setup>` to display a reactive message.

```vue
<script setup>
import { ref } from 'vue';

const message = ref('Hello, World');
</script>
<template>
  <h1>{{ message }}</h1>
</template>

```

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

### Valid Reference Codes Example

Source: https://docs.frappe.io/erpnext/financial-report-template

Illustrates correct formats for reference codes used in financial reports. Reference codes must be unique, start with a letter, and contain only alphanumeric characters and underscores.

```text
✅ REV100, ASSET1
```

```text
❌ 100REV, ASSET-1
```

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

### Setup a New Bench Locally

Source: https://docs.frappe.io/cloud/common-issues/debugging-app-installs-locally

Initialize a new Frappe bench for local development and dependency management. This ensures a clean environment separate from your main bench.

```bash
bench init test-install # At /some/path/test-install

```

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

### Contract Template Example using Jinja

Source: https://docs.frappe.io/erpnext/contract

Demonstrates how to use Jinja templating to create dynamic contract terms. The placeholder `{{ start_date }}` will be replaced with the actual start date when a contract is created using this template.

```jinja
The parties enter into this contract on {{ start_date }}.



```

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

### Download Docker Compose and Init Script

Source: https://docs.frappe.io/drive/quick-start

Download the necessary Docker Compose configuration file and the initialization script for Frappe Drive.

```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/frappe/drive/main/docker/docker-compose.yml
wget -O init.sh https://raw.githubusercontent.com/frappe/drive/main/docker/init.sh

```

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

### SSH Access Denied Error Example

Source: https://docs.frappe.io/cloud/benches/ssh

This error indicates a mismatch between the private key used locally and the public key added to Frappe Cloud. Review your local SSH setup and ensure they correspond.

```bash
identity_sign: private key /home/user/.ssh/id_rsa contents do not match public
```

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

### App Creation Prompts and Output

Source: https://docs.frappe.io/framework

Example of prompts and output when creating a new Frappe app. Fill in details or press Enter for defaults.

```bash
App Title (default: Library Management):
App Description: Library Management System
App Publisher: Faris Ansari
App Email: faris@example.com
App Icon (default 'octicon octicon-file-directory'):
App Color (default 'grey'):
App License (default 'MIT'):
'library_management' created at /home/frappe/frappe-bench/apps/library_management

Installing library_management
$ ./env/bin/pip install -q -U -e ./apps/library_management
$ bench build --app library_management
yarn run v1.22.4
$ FRAPPE_ENV=production node rollup/build.js --app library_management
Production mode
✔ Built js/moment-bundle.min.js
✔ Built js/libs.min.js
✨  Done in 1.95s.

```

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

### Installing a New App (Not Recommended)

Source: https://docs.frappe.io/cloud/benches/debugging

Avoid installing new apps directly on Frappe Cloud benches using `bench new-app` or `bench get-app`. This can lead to issues with bench updates and app persistence.

```bash
bench new-app my_awesome_app
```

```bash
bench get-app my_awesome_app
```

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

### Basic Query Execution with .run()

Source: https://docs.frappe.io/framework/get_query

Demonstrates the different ways to execute a query object created by `frappe.qb.get_query` using the `.run()` method and retrieve results in various formats.

```python
# Returns a list of tuples by default
results = query.run()

# Returns a list of dictionaries
results = query.run(as_dict=True)

# Returns a list of lists
results = query.run(as_list=True)

# If selecting a single field, returns a flat list of values
results = query.run(pluck=True)

# Print the generated SQL query and execution time
results = query.run(debug=True)
```