Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simon-laux/webxdc-game-2024
https://github.com/simon-laux/webxdc-game-2024
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/simon-laux/webxdc-game-2024
- Owner: Simon-Laux
- License: mit
- Created: 2024-04-13T11:34:22.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-10-12T23:58:59.000Z (3 months ago)
- Last Synced: 2024-12-02T17:12:18.883Z (about 1 month ago)
- Language: TypeScript
- Size: 250 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WebXDC Vite Template [](https://github.com/webxdc/webxdc-vite/actions/workflows/ci.yml) [](https://github.com/prettier/prettier)
A minimalist Vite project template for [WebXDC](https://webxdc.org) development.
## Features
- ⚡️ Fast development with [Vite](https://github.com/vitejs/vite) and [pnpm](https://pnpm.js.org/)
- 📱 Integrated [WebXDC emulator](https://github.com/webxdc/webxdc-dev) to test your WebXDC right on the browser while developing,
and [Eruda](https://github.com/liriliri/eruda) to debug inside Delta Chat.
- 📝 Code formatting with [Prettier](https://github.com/prettier/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 dev-mini
# Alternatively to test in a more advanced WebXDC emulator:
pnpm dev
```
### 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**](https://github.com/webxdc/webxdc-vite/generate).