# [![🤿 skuba](./docs/logo.svg)](https://seek-oss.github.io/skuba)

---

[![npm package](https://img.shields.io/npm/v/skuba?labelColor=cb0000&color=5b5b5b)](https://www.npmjs.com/package/skuba)
[![Node.js version](https://img.shields.io/node/v/skuba?labelColor=5fa04e&color=5b5b5b)](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, you may hotload the package with a reasonable `minimumReleaseAge`:

```shell
pnpm --config.minimumReleaseAge=4320 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