/webxdc-vite

A minimalist Vite template for Webxdc development

Primary LanguageHTMLMIT LicenseMIT

WebXDC Vite Template CI code style: prettier

A minimalist Vite project template for WebXDC development.

Features

  • ⚡️ Fast development with Vite and pnpm

  • 📱 Integrated WebXDC emulator to test your WebXDC right on the browser while developing, and Eruda to debug inside Delta Chat.

  • 📝 Code formatting with Prettier

  • 📦 Automatically minify, build and release your .xdc file

  • 🦕 Automatically support legacy/old browsers

Usage

Installing Dependencies

After cloning this repo, install dependecies:

pnpm i

Checking code format

pnpm check

Testing the app in the browser

To test your work in your browser (with hot reloading!) while developing:

pnpm start
# Alternatively to test in a more advanced WebXDC emulator:
pnpm emulator

Building

To package the WebXDC file:

pnpm build

To package the WebXDC with developer tools inside to debug in Delta Chat, set the NODE_ENV environment variable to "debug":

NODE_ENV=debug pnpm build

The resulting optimized .xdc file is saved in dist-xdc/ folder.

Releasing

To automatically build and create a new GitHub release with the .xdc file:

git tag -a v1.0.1
git push origin v1.0.1

Try it now!

Create a repo from this template on GitHub.