https://github.com/seek-oss/skuba
🤿 SEEK development toolkit for backend applications and packages
https://github.com/seek-oss/skuba
owner-sig-backend-tooling toolkit typescript
Last synced: about 1 month ago
JSON representation
🤿 SEEK development toolkit for backend applications and packages
- Host: GitHub
- URL: https://github.com/seek-oss/skuba
- Owner: seek-oss
- License: mit
- Created: 2020-06-01T03:06:30.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2026-03-01T09:55:43.000Z (4 months ago)
- Last Synced: 2026-03-01T10:55:08.152Z (4 months ago)
- Topics: owner-sig-backend-tooling, toolkit, typescript
- Language: TypeScript
- Homepage: https://seek-oss.github.io/skuba/
- Size: 11.6 MB
- Stars: 63
- Watchers: 10
- Forks: 36
- Open Issues: 76
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# [](https://seek-oss.github.io/skuba)
---
[](https://www.npmjs.com/package/skuba)
[](https://www.npmjs.com/package/skuba)
---
**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 [Vitest]
- Deploy with [Gantry] or the [AWS CDK]
[aws cdk]: https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-typescript.html
[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
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](docs/about.md) **skuba** and [contribute](CONTRIBUTING.md) to it.
---
**skuba** is distributed as an npm package.
In projects that list it as a `devDependency`,
usage may look something like this:
```shell
# Install project dependencies.
pnpm install
# Run the skuba CLI.
pnpm exec skuba help
```
When starting a new project, using the latest version is recommended:
```shell
pnpm dlx skuba init
```
If you're new here, jump ahead to the [CLI] section to [create a new project] or [update an existing one].
[cli]: ./docs/cli
[create a new project]: ./docs/cli/init.md
[development]: ./docs/development-api
[eslint]: https://eslint.org/
[vitest]: https://vitest.dev/
[prettier]: https://prettier.io/
[runtime]: ./docs/runtime-api
[templates]: ./docs/templates
[typescript]: https://www.typescriptlang.org/
[update an existing one]: ./docs/cli/configure.md