mirror of
https://github.com/zos-apps/app-template.git
synced 2026-11-04 17:34:47 +00:00
main
zOS App Template
A template for creating zOS applications with TypeScript, React, and full CI/CD.
Features
- β‘ Quick Start - Clone and deploy in minutes
- π¦ TypeScript - Full type support with declarations
- π§ CI/CD - GitHub Actions for build, test, and release
- πͺ App Store - Automatic integration with zOS App Store
- π GitHub Pages - Landing page ready to deploy
Quick Start
Option 1: Use GitHub Template
Click "Use this template" on GitHub or:
gh repo create my-app --template zos-apps/app-template
cd my-app
npm install
npm run dev
Option 2: Clone and Fork
git clone https://github.com/zos-apps/app-template.git my-app
cd my-app
rm -rf .git
git init
npm install
npm run dev
Configuration
1. Update package.json
Edit the package.json file to customize your app:
{
"name": "@zos-apps/my-app",
"version": "1.0.0",
"zos": {
"id": "com.yourname.my-app",
"name": "My App",
"icon": "π―",
"category": "utilities",
"description": "Your app description",
"window": {
"defaultSize": { "width": 800, "height": 600 },
"resizable": true
}
}
}
2. App Categories
Available categories:
utilities- Tools and utilitiesproductivity- Work and productivity appsgames- Games and entertainmentsocial- Social and communicationmedia- Music, video, photosdeveloper- Developer toolsfinance- Finance and cryptoeducation- Learning appslifestyle- Health, weather, etc.
3. Window Options
{
"window": {
"defaultSize": { "width": 800, "height": 600 },
"minSize": { "width": 400, "height": 300 },
"maxSize": { "width": 1200, "height": 800 },
"resizable": true,
"frame": true,
"transparent": false
}
}
Development
# Install dependencies
npm install
# Start development (watches for changes)
npm run dev
# Build for production
npm run build
# Type check
npm run typecheck
# Lint (if configured)
npm run lint
Publishing
1. Set Up npm Token
Add NPM_TOKEN to your repository secrets:
- Go to Settings β Secrets and variables β Actions
- Add
NPM_TOKENwith your npm access token
2. Create a Release
# Bump version
npm version patch # or minor, major
# Push with tags
git push --follow-tags
The release workflow will automatically:
- Build the app
- Publish to npm
- Create a GitHub release
- Notify the App Store
Project Structure
my-app/
βββ .github/
β βββ workflows/
β βββ ci.yml # Build on push/PR
β βββ release.yml # Publish on tags
β βββ pages.yml # Deploy landing page
βββ docs/
β βββ index.html # Landing page
β βββ _config.yml # Jekyll config
βββ screenshots/
β βββ hero.png # App screenshot
βββ src/
β βββ index.tsx # Main component
βββ .gitignore
βββ package.json
βββ tsconfig.json
βββ tsup.config.ts
βββ README.md
zOS Manifest Reference
Full manifest options in package.json:
{
"zos": {
"id": "com.example.app",
"name": "App Name",
"icon": "π―",
"category": "utilities",
"description": "Short description",
"permissions": ["filesystem", "network"],
"window": {
"defaultSize": { "width": 800, "height": 600 },
"minSize": { "width": 400, "height": 300 },
"resizable": true
},
"about": "Longer about text",
"help": ["Help item 1", "Help item 2"],
"docs": "https://docs.example.com",
"site": "https://example.com",
"shortcuts": ["Cmd+S Save", "Cmd+N New"],
"features": ["Feature 1", "Feature 2"],
"screenshots": {
"hero": "screenshots/hero.png",
"images": ["screenshots/1.png"]
},
"downloads": {
"web": "https://example.com"
},
"featured": false,
"tags": ["tag1", "tag2"],
"releaseDate": "2024-12-29",
"support": "https://github.com/user/app/issues",
"changelog": "https://github.com/user/app/releases"
}
}
Contributing
- Fork the repository
- Create your feature branch
- Commit your changes
- Push to the branch
- Open a Pull Request
License
MIT
Built with β€οΈ for zOS
Languages
TypeScript
100%