Skip to content

Add platform guide to deploy on Appwrite #7485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add platform guide to deploy on Appwrite #7485

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82d03e7
docs: Add platform guide to deploy on Appwrite
adityaoberai Oct 22, 2025
f3da481
Minor updates in title and description of Appwrite Sites section
adityaoberai Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion docs/guide/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ You can deploy a fresh Vue project, with a Git repository set up for you, with t

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/git?s=https%3A%2F%2Fgithub.com%2Fvercel%2Fvercel%2Ftree%2Fmaster%2Fexamples%2Fvue)

## References:
#### References:

- [Example Source](https://github.com/vercel/vercel/tree/master/examples/vue)
- [Official Vercel Guide](https://vercel.com/guides/deploying-vuejs-to-vercel)
Expand Down Expand Up @@ -514,3 +514,36 @@ Deploy your application using nginx inside of a docker container.
curl localhost:8080
# <!DOCTYPE html><html lang=en>...</html>
```
### Appwrite Sites

[Appwrite](https://appwrite.io) is an open-source, all-in-one cloud development platform that offers developers built-in backend infrastructure and web hosting for their apps. All web apps deployed on [Appwrite Sites](https://appwrite.io/products/sites) benefit from a global CDN, automatic deployments from GitHub, and various security features, including DDoS protection, Web Application Firewall (WAF), and TLS encryption.

#### Step 1: Create Vue.js app

Create a new Vue.js app using the Vue CLI (or setup [Appwrite's Vue.js starter template](https://github.com/appwrite/templates-for-sites/tree/main/vue/starter)) and push this project to a [GitHub repo](https://github.com/new).

#### Step 2: Setup Appwrite project

Head to the [Appwrite Console](https://cloud.appwrite.io/) and create a project.

#### Step 3: Deploy site

Head to the **Sites** page in your Appwrite project from the sidebar, click on the **Create site** button, and select **Connect a repository**.

Connect your GitHub account and select the repository you intend to deploy.

1. Select the **production branch** and **root directory** from your repo.
2. Verify that the **correct framework** is selected. In case an incorrect framework is visible, pick **Vue.js** from the drop-down list.
3. Confirm the **install command**, **build command**, and **output directory** in the build settings. The default build settings for Vue.js are:
- **Install command:** `npm install`
- **Build command:** `npm run build`
- **Output directory:** `./dist`
4. Add any environment variables required by the site.

Click on the **Deploy** button. After successful deployment, you can visit your site.

#### More resources

- [Appwrite Sites docs](https://appwrite.io/docs/products/sites)
- [Appwrite's Vue.js starter template](https://github.com/appwrite/templates-for-sites/tree/main/vue/starter)