This template is part of ArcAO Templates, designed to help you get your game idea up and running fast!
A modern web application template built with:
- React - A JavaScript library for building user interfaces
- TypeScript - JavaScript with syntax for types
- Vite - Next Generation Frontend Tooling
- ArNS - The Permaweb Name System for permanent web deployment
This template provides a minimal setup to get started with React development and automated deployment to both the permaweb (via ArNS) and traditional hosting servers.
For development setup instructions, please see our Development Guide.
This template supports two deployment methods, both automated via GitHub Actions:
Deploy your application to the permanent web using Arweave's decentralized storage and ArNS for permanent, censorship-resistant hosting.
Requirements:
- Arweave wallet with Turbo Credits
- ArNS name ownership or controller access
- GitHub secrets:
DEPLOY_KEY - GitHub variables:
DEPLOY_ARNS_NAME,DEPLOY_UNDERNAME(optional)
📖 Full Permaweb Deployment Guide
Deploy your application to a physical server or VPS via SSH/SCP with automatic nginx reload.
One-Time Setup (choose what applies):
- 📋 Server Setup - Create deploy user & configure SSH keys
- 🌐 Nginx & SSL Setup - Configure nginx web server & SSL certificates
GitHub Configuration:
- GitHub secrets:
SSH_PRIVATE_KEY,SERVER_IP
What's Automated:
- ✅ Build process
- ✅ Directory creation on server (
/home/deploy/YOUR-REPO-NAME/) - ✅ File transfer via SCP
- ✅ Nginx reload
📖 Complete SSH Deployment Documentation
Both deployments are triggered automatically on every push to the master branch. You can disable either workflow by deleting or disabling the respective workflow file in .github/workflows/.
Need a quick summary of all secrets, variables, and setup steps? Check out the Deployment Quick Reference.
See LICENSE for more information.