### Install Appwrite on macOS and Linux Source: https://appwrite.io/docs/advanced/self-hosting/installation Use this command to start the Appwrite installation wizard on macOS and Linux systems. Ensure Docker CLI is installed. ```Bash docker run -it --rm \ --publish 20080:20080 \ --volume /var/run/docker.sock:/var/run/docker.sock \ --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \ --entrypoint="install" \ appwrite/appwrite:1.9.0 ``` -------------------------------- ### Navigate and Install Dependencies Source: https://appwrite.io/docs/tutorials/nextjs-ssr-auth/step-2 Change into your new project directory and install the necessary npm packages. ```Shell cd my-app npm install ``` -------------------------------- ### Appwrite Project Configuration Example Source: https://appwrite.io/docs/command-line Example of the 'appwrite.config.json' file created after initializing a project. ```json { "projectId": "", "endpoint": "https://.cloud.appwrite.io/v1" } ``` -------------------------------- ### Install Appwrite on Windows (CMD) Source: https://appwrite.io/docs/advanced/self-hosting/installation Execute this command in the Windows Command Prompt (CMD) to initiate the Appwrite installation. Docker CLI must be installed. ```CMD docker run -it --rm ^ --publish 20080:20080 ^ --volume //var/run/docker.sock:/var/run/docker.sock ^ --volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^ --entrypoint="install" ^ appwrite/appwrite:1.9.0 ``` -------------------------------- ### Install Appwrite on Windows (PowerShell) Source: https://appwrite.io/docs/advanced/self-hosting/installation Run this command in Windows PowerShell to start the Appwrite installation process. Docker CLI is required. ```PowerShell docker run -it --rm ` --publish 20080:20080 ` --volume /var/run/docker.sock:/var/run/docker.sock ` --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw ` --entrypoint="install" ` appwrite/appwrite:1.9.0 ``` -------------------------------- ### Install Go Appwrite SDK Source: https://appwrite.io/docs/quick-starts/go Install the Appwrite SDK for Go to integrate Appwrite services into your application. ```sh go get github.com/appwrite/sdk-for-go ``` -------------------------------- ### Install Node.js Appwrite SDK Source: https://appwrite.io/docs/quick-starts/node Install the Node.js Appwrite SDK using npm. ```sh npm install node-appwrite ``` -------------------------------- ### Create TanStack Start App Source: https://appwrite.io/docs/products/sites/quick-start/tanstack-start Use this command to create a new TanStack Start application or set up the starter template. ```bash npm create @tanstack/start@latest ``` -------------------------------- ### Install Appwrite SDK Source: https://appwrite.io/docs/quick-starts/angular Install the Appwrite JavaScript SDK using npm. This command is run in the shell. ```Shell npm install appwrite ``` -------------------------------- ### Install React Navigation Source: https://appwrite.io/docs/tutorials/react-native/step-2 Install the core React Navigation library and the native stack navigator for implementing navigation. ```shell npm install @react-navigation/native @react-navigation/native-stack ``` -------------------------------- ### API Reference Prompt Example Source: https://appwrite.io/docs/tooling/ai/mcp-servers/docs Use this prompt to request a Python code example for listing all users. ```Text I want an example of how I can list all users in a Python app ``` -------------------------------- ### Install Appwrite SDK Source: https://appwrite.io/docs/quick-starts/python Install the Appwrite Python SDK using pip or uv. This makes the Appwrite functionalities available in your project. ```sh pip install appwrite ``` ```sh uv add appwrite ``` -------------------------------- ### Appwrite Go SDK Main Function Setup Source: https://appwrite.io/docs/quick-starts/go Initializes the Appwrite client with project and API keys, prepares the database, seeds it with data, and then calls functions to retrieve different sets of todos. Replace `` and `` with your actual credentials. ```go package main import ( "fmt" "github.com/appwrite/sdk-for-go/appwrite" "github.com/appwrite/sdk-for-go/client" "github.com/appwrite/sdk-for-go/tablesdb" "github.com/appwrite/sdk-for-go/id" "github.com/appwrite/sdk-for-go/models" "github.com/appwrite/sdk-for-go/query" ) var ( appwriteClient client.Client todoDatabase *models.Database todoTable *models.Table tablesDB *tablesdb.TablesDB ) func main() { appwriteClient = appwrite.NewClient( appwrite.WithProject(""), appwrite.WithKey(""), ) prepareDatabase() seedDatabase() getTodos() getCompletedTodos() getIncompleteTodos() } ``` -------------------------------- ### Install httparty for Ruby Source: https://appwrite.io/docs/products/functions/examples Installs the httparty library, which provides a get function for making HTTP requests. ```bash echo "gem 'httparty'" >> Gemfile bundle install ``` -------------------------------- ### Initialize a New Site with CLI Source: https://appwrite.io/docs/products/sites/deploy-from-cli Use this command to create a starter site project via the Appwrite CLI. Ensure you have installed and logged into the CLI, and initialized your Appwrite project. ```shell appwrite init sites ``` -------------------------------- ### Install http for Dart Source: https://appwrite.io/docs/products/functions/examples Installs the http library, which provides a get function for making HTTP requests. ```bash pub install http ``` -------------------------------- ### Create Go Project and Initialize Module Source: https://appwrite.io/docs/quick-starts/go Use these commands to create a new Go project directory and initialize a Go module. ```sh mkdir my-app cd my-app go mod init go-appwrite/main ``` -------------------------------- ### Install requests for Python Source: https://appwrite.io/docs/products/functions/examples Installs the requests library, which provides a get function for making HTTP requests. ```bash echo "requests" >> requirements.txt pip install -r requirements.txt ``` -------------------------------- ### Install guzzlehttp/guzzle for PHP Source: https://appwrite.io/docs/products/functions/examples Installs the guzzlehttp/guzzle library, which provides a get function for making HTTP requests. ```bash composer require guzzlehttp/guzzle ``` -------------------------------- ### Project Structure Example Source: https://appwrite.io/docs/products/sites/deploy-manually This illustrates a typical project directory structure for a web application, such as a SvelteKit app, before building. ```bash . ├ src/ ├ static/ ├ package.json ├ svelte.config.js ├ tsconfig.json └ vite.config.js ``` -------------------------------- ### Install iOS Pods Source: https://appwrite.io/docs/tutorials/react-native/step-2 For iOS projects, navigate to the ios directory and install CocoaPods to complete the React Navigation setup. ```shell cd ios pod install cd .. ``` -------------------------------- ### Create Deno Project Source: https://appwrite.io/docs/quick-starts/deno Create a new Deno project directory and a basic entry point file. ```shell mkdir my-app cd my-app echo "console.log('Hello, Deno!');" > mod.ts ``` -------------------------------- ### Get Tables Rows (Server Integration Example) Source: https://appwrite.io/docs/apis/rest Retrieves rows from a specific table within a database. This example demonstrates server-side authentication using an API key. ```APIDOC ## GET /v1/tablesdb/{databaseId}/tables/{tableId}/rows ### Description Retrieves rows from a specific table within a database. This example demonstrates server-side authentication using an API key. ### Method GET ### Endpoint /v1/tablesdb/{databaseId}/tables/{tableId}/rows ### Parameters #### Path Parameters - **databaseId** (string) - Required - The ID of the database. - **tableId** (string) - Required - The ID of the table. ### Headers - **X-Appwrite-Project**: [PROJECT-ID] - **X-Appwrite-Key**: [API_KEY] ### Request Example ```json GET /v1/tablesdb/{databaseId}/tables/{tableId}/rows HTTP/1.1 Content-Type: application/json X-Appwrite-Project: X-Appwrite-Key: [API_KEY] ``` ``` -------------------------------- ### Appwrite Configuration File Example Source: https://appwrite.io/docs/tooling/command-line/topics An example of the `appwrite.config.json` file after initializing a project and pulling topics. It shows the structure for projectId, endpoint, and the topics array with their configurations. ```json { "projectId": "", "endpoint": "https://.cloud.appwrite.io/v1", "topics": [ { "$id": "N1IzUIJiOicGbhJye", "$createdAt": "2024-07-01T14:40:43.381+00:00", "$updatedAt": "2024-07-01T14:40:43.381+00:00", "name": "Anime", "emailTotal": 3, "smsTotal": 0, "pushTotal": 0, "subscribe": [ "users" ] }, { "$id": "eyJhbGciOiJIUzI1N", "$createdAt": "2024-07-01T14:41:19.029+00:00", "$updatedAt": "2024-07-01T14:41:28.751+00:00", "name": "Music", "emailTotal": 2, "smsTotal": 0, "pushTotal": 0, "subscribe": [ "users", "any" ] } ] } ``` -------------------------------- ### Node.js Function Entrypoint Example Source: https://appwrite.io/docs/products/functions/develop This Node.js example demonstrates a basic Appwrite Function entrypoint. It shows how to use the context object for logging and sending responses. The function handles GET requests differently from other methods. ```javascript import { Client } from 'node-appwrite'; // This is your Appwrite function // It's executed each time we get a request export default async ({ req, res, log, error }) => { // Why not try the Appwrite SDK? // // Set project and set API key // const client = new Client() // .setProject(process.env.APPWRITE_FUNCTION_PROJECT_ID) // .setKey(req.headers['x-appwrite-key']); // You can log messages to the console log('Hello, Logs!'); // If something goes wrong, log an error error('Hello, Errors!'); // The `req` object contains the request data if (req.method === 'GET') { // Send a response with the res object helpers // `res.text()` dispatches a string back to the client return res.text('Hello, World!'); } // `res.json()` is a handy helper for sending JSON return res.json({ motto: 'Build like a team of hundreds_', learn: 'https://appwrite.io/docs', connect: 'https://appwrite.io/discord', getInspired: 'https://builtwith.appwrite.io', }); }; ``` -------------------------------- ### Appwrite Rust SDK Main Function Setup Source: https://appwrite.io/docs/quick-starts/rust This snippet shows the main function setup for a Rust application using the Appwrite SDK. It initializes the client, prepares the database, seeds it with data, and then retrieves the todos. ```rust use appwrite::Client; use appwrite::services::tables_db::TablesDB; use appwrite::id::ID; use appwrite::query::Query; use serde_json::json; #[tokio::main] async fn main() -> Result<(), Box> { let client = Client::new() .set_endpoint("https://.cloud.appwrite.io/v1") .set_project("") .set_key(""); let tables_db = TablesDB::new(&client); let (database_id, table_id) = prepare_database(&tables_db).await?; seed_database(&tables_db, &database_id, &table_id).await?; get_todos(&tables_db, &database_id, &table_id).await?; Ok(()) } ``` -------------------------------- ### Create Execution Source: https://appwrite.io/docs/references/cloud/server-nodejs/functions Triggers a function execution. The function execution starts asynchronously. You can monitor the status using the 'Get Execution' endpoint. ```APIDOC ## POST /functions/{functionId}/executions ### Description Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously. ### Method POST ### Endpoint /functions/{functionId}/executions ### Parameters #### Path Parameters - **functionId** (string) - Required - Function ID. #### Request Body - **body** (string) - Optional - HTTP body of execution. Default value is empty string. - **async** (boolean) - Optional - Execute code in the background. Default value is false. - **path** (string) - Optional - HTTP path of execution. Path can include query params. Default value is "/". - **method** (string) - Optional - HTTP method of execution. Default value is POST. - **headers** (object) - Optional - HTTP headers of execution. Defaults to empty. - **scheduledAt** (string) - Optional - Scheduled execution time in ISO 8601 format. DateTime value must be in future with precision in minutes. ### Response #### Success Response (201) - **multipart/form-data** - Execution details. ``` -------------------------------- ### Initialize Appwrite Client and Services Source: https://appwrite.io/docs/tutorials/react-native/step-3 Set up the Appwrite client with your project endpoint, project ID, and platform. Export instances of Account and TablesDB for use throughout your application. Remember to replace placeholder values with your actual project details. ```javascript import { Client, TablesDB, Account } from "react-native-appwrite"; const client = new Client(); client .setEndpoint("https://.cloud.appwrite.io/v1") .setProject("") // Replace with your project ID .setPlatform('com.example.idea-tracker'); export const account = new Account(client); export const tablesDB = new TablesDB(client); ``` -------------------------------- ### Initialize Appwrite Functions with CLI Source: https://appwrite.io/docs/products/functions/deploy-manually Use this command to create a starter function template. Paste your code into the generated file and folder. ```shell appwrite init functions ``` -------------------------------- ### Get QR Code for MFA Source: https://appwrite.io/docs/products/auth/mfa Generates a QR code resource URL from a given text, typically used for MFA setup. ```javascript const result = await avatars.getQR({ text: uri, size: 800, // optional margin: 0, // optional download: false // optional }); console.log(result); // Resource URL ``` -------------------------------- ### Create PHP Project Source: https://appwrite.io/docs/quick-starts/php Use Composer to initialize a new PHP project and install the Appwrite SDK. ```sh mkdir my-app cd my-app composer init ``` ```sh composer require appwrite/appwrite:15.0.0 ``` -------------------------------- ### Create Function Execution (Web) Source: https://appwrite.io/docs/references/cloud/client-web/functions Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously. ```javascript import { Client, Functions, ExecutionMethod } from "appwrite"; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID const functions = new Functions(client); const result = await functions.createExecution({ functionId: '', body: '', // optional async: false, // optional xpath: '', // optional method: ExecutionMethod.GET, // optional headers: {}, // optional scheduledAt: '' // optional }); console.log(result); ``` -------------------------------- ### Run Nuxt.js Development Server Source: https://appwrite.io/docs/tooling/ai/quickstart-prompts/nuxt Starts the Nuxt.js development server with automatic opening in the browser on the specified port. Ensure you have the necessary dependencies installed. ```bash npm run dev -- --open --port 3000 ``` -------------------------------- ### MainActivity Implementation Source: https://appwrite.io/docs/quick-starts/android-java Sets up the main activity, initializes Appwrite, and handles UI component interactions for login, registration, and logout. ```java package ; import android.os.Bundle; import android.util.Log; import android.view.View; import android.widget.Button; import android.widget.EditText; import android.widget.TextView; import android.widget.Toast; import androidx.appcompat.app.AppCompatActivity; import java.util.Map; import io.appwrite.models.Session; import io.appwrite.models.User; public class MainActivity extends AppCompatActivity { private static final String TAG = "MainActivity"; private EditText editTextEmail; private EditText editTextPassword; private Button buttonLogin; private Button buttonRegister; private TextView textViewStatus; private Button buttonLogout; private AppwriteHelper appwrite; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); // Initialize Appwrite appwrite = AppwriteHelper.getInstance(getApplicationContext()); setContentView(R.layout.activity_main); // Initialize UI components editTextEmail = findViewById(R.id.editTextEmail); editTextPassword = findViewById(R.id.editTextPassword); buttonLogin = findViewById(R.id.buttonLogin); buttonRegister = findViewById(R.id.buttonRegister); textViewStatus = findViewById(R.id.textViewStatus); buttonLogout = findViewById(R.id.buttonLogout); buttonLogin.setOnClickListener(v -> { String email = editTextEmail.getText().toString(); String password = editTextPassword.getText().toString(); appwrite.login(email, password, new AuthCallback() { @Override public void onSuccess(Session result) { Log.d(TAG, "Login successful: " + result.getUserId()); textViewStatus.setText("Logged in as: " + result.getUserId()); textViewStatus.setVisibility(View.VISIBLE); buttonLogout.setVisibility(View.VISIBLE); editTextEmail.setVisibility(View.GONE); editTextPassword.setVisibility(View.GONE); buttonLogin.setVisibility(View.GONE); buttonRegister.setVisibility(View.GONE); } @Override public void onError(Exception error) { Log.e(TAG, "Login failed: " + error.getMessage()); Toast.makeText(MainActivity.this, "Login failed: " + error.getMessage(), Toast.LENGTH_SHORT).show(); } }); }); buttonRegister.setOnClickListener(v -> { String email = editTextEmail.getText().toString(); String password = editTextPassword.getText().toString(); appwrite.register(email, password, new AuthCallback>>() { @Override public void onSuccess(User> result) { Log.d(TAG, "Registration successful: " + result.getId()); Toast.makeText(MainActivity.this, "Registration successful! Please login.", Toast.LENGTH_SHORT).show(); } @Override public void onError(Exception error) { Log.e(TAG, "Registration failed: " + error.getMessage()); Toast.makeText(MainActivity.this, "Registration failed: " + error.getMessage(), Toast.LENGTH_SHORT).show(); } }); }); buttonLogout.setOnClickListener(v -> { appwrite.logout(new AuthCallback