🗃️ The code is in GitLab

🚀 Astro Appwrite Starter Kit

A minimal template for Astro projects with Appwrite integration, designed to accelerate modern web application development.

📋 Prerequisites

Before getting started, ensure you have installed:

• 🟢 Node.js (version 22 or higher)
• 🔴 Appwrite (version 2 or higher)
• 🖥️ Appwrite CLI (Installation Guide) (recommended)
• 💻 VSCode (recommended)

🛠️ Technologies and Dependencies

• Frontend:
  • Astro - Modern web framework
  • TypeScript - Static typing
  • WebCoreUI - Component library
  • Sass - CSS preprocessor

🚀 Getting Started

1. Clone the Repository

git clone https://github.com/emanuelsaramago/astro-appwrite-starter.git
cd astro-appwrite-starter

2. Install Dependencies

npm install

3. Environment Setup

1. Copy .env.example to .env
2. Create a new project in your Appwrite instance, then:
   • Set up a database, collection, and user
   • Generate an API key
3. Fill the .env file with the required values

4. Appwrite Initialization

# Initialize project
appwrite init project

# Generate TypeScript types
appwrite types src/types

🖥️ Development

Start Development Server

In VSCode:

1. Go to Debugger Mode
2. Select "Development server"
3. Click "Start Debugging" button or press F5
4. Open in browser: http://localhost:1234

🧩 UI Components

UI component documentation: WebCoreUI Docs

📂 Folder Structure

src/
├── components/   # Reusable UI components
├── layouts/      # Layout templates
├── pages/        # Pages and API routes
├── styles/       # Global styles
├── utils/        # Utility functions
└── lib/          # Appwrite client and services

🤝 Contributing

Feel free to open issues or send pull requests. All contributions are welcome!

📄 License

This project is under the MIT License. See the LICENCE.md file for more details.