@skeet-framework/base-temlate
v1.0.6
Published
Skeet Framework Base Template
Downloads
4
Readme
📗 Doc: https://skeet.dev/
📱 Demo App: https://skeeter.dev/
💃 What's Skeet? 🕺
⚡️ AI Auto-code Development ⚡️
Skeet is an open-source app development solution capable of AI auto-code development.
It allows for rapid development of Web/iOS/Android apps and supports a wide range of developments, including AI-powered chatbot apps, Web3 apps utilizing blockchain, and dApps.
AI is also used in the development flow, overcoming the learning curve that is a challenge in software frameworks.
Developers can quickly start building functional apps and publish them in the cloud.
Overall Architecture Diagram
Skeet is an open-source framework for serverless app development crafted in TypeScript.
It offers the flexibility to select functionalities and the ability to build additional web or mobile interfaces and sophisticated data analytics foundations later on.
It supports Web3 development, eliminates complex infrastructure management, and facilitates auto-scaling and pay-as-you-go pricing.
The Skeet CLI leverages generative AI to reduce overall development costs, is ready for CI/CD automation, and provides enhanced security features.
Currently, it supports development on Google Cloud and Firebase.
Installation
$ sh -c "$(curl -sSfL https://storage.googleapis.com/skeet-assets/resources/install-v2.0.1)"
If you already have pnpm installed, you can install Skeet CLI with pnpm:
$ pnpm add -g @skeet-framework/cli
Enabling Google Cloud VertexAI/OpenAI
Create a new project in Google Cloud Platform and enable VertexAI. You will need OpenAI API Key to use OpenAI.
Use the following command to enable VertexAI:
$ skeet iam ai
$ skeet ai
or you can choose AI engine by passing options
$ skeet ai --openai
You need to set CHAT_GPT_ORG/CHAT_GPT_KEY in your .env
Then you can ask Skeet AI Assistant to create a new function, method, typedoc and more.
YouTube Video Link: https://www.youtube.com/watch?v=e7J5HDhtpE4
🧪 Dependency 🧪
- TypeScript ^5.0.0
- Node.js ^20.0.0
- PNPM ^8.0.0
- GitHub CLI ^2.29.0
For Firebase Template
- Google Cloud SDK ^430.0.0
- Firebase CLI ^13.0.0
- Java
📗 Usage 📗
Install PNPM
$ curl -fsSL https://get.pnpm.io/install.sh | sh -
① Install Skeet/Firebase CLI
$ pnpm add -g @skeet-framework/cli
$ pnpm add -g firebase-tools
② Create Skeet App
$ skeet create <appName>
You can choose a template for the frontend and backend.
- Next.js (React) with Firestore template
- Expo (React Native) with Firestore template
- Solana Mobile Stack (Expo) + Web (Next.js) with Firestore template
- Backend Only - Firestore template
③ Run Skeet App
$ cd <appName>
$ skeet s
or
put options to run only backend, frontend or functions
Usage: skeet server|s [options]
Run Skeet App
Options:
-b, --backend Run Backend only
-f, --functions Run Firebase Functions only
-w, --web Run Web App only
-h, --help display help for command
Now you have both frontend and backend running locally ⭐️
📲 Frontend(Next.js) - http://localhost:4200/
📲 Frontend(Expo) - http://localhost:19006/
💻 Firebase Emulator - http://localhost:4000/
Launching Skeet AI Assistant
The Skeet AI Assistant is an interactive tool designed to handle various queries.
$ skeet ai --help
AI Playground
Options:
-v, --vertex Vertex AI
-o, --openai OpenAI
-h, --help display help for command
Upon launching, you'll see a prompt like the one below. Try asking it something:
skeet ai --openai
╔═════════════╤════════╗
│ Option │ Value │
╟─────────────┼────────╢
│ AI Type │ OpenAI │
╚═════════════╧════════╝
🤖 Skeet AI Mode
`$ <mode>` to change AI mode 🤖
OpenAI is selected 🤖 (type 'q' to quit)
? What can I do for you?
You:
Skeet Document
Skeet CLI
$ skeet --help
Usage: skeet [options] [command]
CLI for Skeet - Full-stack TypeScript Serverless framework
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
create [options] <appName> Create Skeet Framework App
server|s [options] Run Skeet App
deploy [options] Deploy Skeet APP to Firebase
init [options] Initialize Google Cloud Setups for Skeet APP
login Skeet Login Command - Create Firebase Login Token
curl [options] <methodName> Skeet Curl Command - Call Firebase Functions Endpoint
g|generate Skeet Generate Comannd
release|r [options] Release a new version
log [options] Deploy Skeet APP to Firebase
docker Docker commands
db Database commands
iam Skeet IAM Comannd to setup Google Cloud Platform
add Skeet Add Comannd to add new functions
sync Skeet Sync Comannd to sync backend and frontend
delete|d Skeet Delete Command
get Get Skeet App List
ai [options] AI Playground
config Config commands
run [options] Run commands
help [command] display help for command
Powered by
- Firebase - Serverless Platform
- Firestore - NoSQL Database
- Firebase Cloud Functions 2nd Gen - FaaS
- Firebase Storage - Cloud Storage
- Firebase Authentication - Auth
- Cloud SQL - Relational Database
- Cloud Load Balancing - Routing
- Prisma - ORM
- TypeScript - TypeCheck
- ESLint - Linter
- Prettier - Formatter
- Next.js (React) - Web Frontend(SSG)
- Expo (React Native) - Mobile App
- Hono - API Server
- Neon - Serverless Postgres
Contributing
Bug reports and pull requests are welcome on GitHub at This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The package is available as open source under the terms of the Apache-2.0 License.
Code of Conduct
Example file is CODE_OF_CONDUCT.md in this repository. Please change to your email address.