Skip to content

elsoul/skeet-og

Repository files navigation

Skeet Framework Logo

Follow @ELSOUL_LABO2

Skeet TypeScript Serverless Framework

Nexus Prisma, GraphQL, Relay Connection, ApolloServer with Express, TypeScript, PostgreSQL, Jest Test, Google Cloud Run

🚧🚧🚧 This architecture of Skeet is deprecated. 🚧🚧🚧

The new architecture of Skeet is here: https://github.com/elsoul/skeet-cli

What's Skeet?

TypeScript Serverless Framework 'Skeet'.

The Skeet project was launched with the goal of reducing software development, operation, and maintenance costs.

Build Serverless Apps faster. Powered by TypeScript GraphQL, Prisma, Jest, Prettier, and Google Cloud.

Dependency

Usage

Install skeet

$ npm i -g skeet

Create Skeet API

$ skeet create ${appName}

Skeet Create

Run local

$ skeet s

Now you can access;

http://localhost:4000/graphql

Zero to Deploy

Git Init

$ skeet init

Document

Deploy All Services to Google Cloud Run

$ skeet deploy

Skeet Deploy

Add Web3 Worker Plugins

Add Web3 Worker Plugin by Skeet CLI

$ skeet add workerPlugin
? Select Services to deploy (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to proceed)
  = Plugins =
❯◯ solana-transfer
 ◯ orca-swap
 ◯ jupiter-swap

This command deploy Skeet Worker Plugin Container To Google Cloud Run. Skeet API can run tasks by Google Cloud Task.

Document: https://skeet.dev

Skeet CLI

$ skeet --help
Usage: skeet [options] [command]

CLI to Skeet TypeScript Serverless Framework

Options:
  -V, --version             output the version number
  -h, --help                display help for command

Commands:
  test
  create <initAppName>      Create Skeet App
  init                      Setup Google Cloud Platform
  server|s                  Run Skeet Server
  deploy                    Deploy to Google Cloud Run
  yarn [options] <yarnCmd>
  add                       Add Comannd
  g|generate                Generate Comannd
  d|delete                  Delete Comannd
  db                        DB Command
  sql                       CloudSQL Comannd
  setup                     Setup Command
  sync                      Sync Command
  docker                    Docker Command
  help [command]            display help for command

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/elsoul/skeet 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

Everyone interacting in the SKEET project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.