seek-oss / skuba

🤿 SEEK development toolkit for backend applications and packages

---

---

skuba is a toolkit for backend application and package development on SEEK's gravel and paved roads:

• Write in TypeScript
• Enforce coding standards with ESLint and Prettier
• Test with Jest
• Deploy with Gantry, Serverless or the AWS CDK

It provides you with:

• CLI commands for developing your project
• Templates to base your backend application or package on
• Development and optional runtime APIs for cross-cutting concerns

Learn more about skuba and contribute to it.

---

skuba is distributed as an npm package.

In projects that list it as a devDependency, usage may look something like this:

# Install project dependencies.
pnpm install

# Run the skuba CLI.
pnpm exec skuba help

Global installations are also supported to speed up local development:

# Install skuba globally.
pnpm add --global skuba

# Look, no `npx`!
skuba help

If you're new here, jump ahead to the CLI section to create a new project or update an existing one.