A TypeScript toolkit for building endurance sports applications.
Status | Owner | Help |
---|---|---|
Active | @openendurance/fkt | New issue |
Name | NPM |
---|---|
fkt |
The @openendurance/fkt repository is a monorepo made up of npm packages, CLI tools, documentation, and websites.
The project is structured like so:
fkt/
├── documentation # Documentation for working in the monorepo
├── fkt-core # The core SDK
└── fkt.openendurance.org # Documentation website
yarn && yarn build
One workspace
Run commands from a selected workspace using turbo run <command> --filter=<workspace>...
flag.
Command | Runs |
---|---|
yarn turbo run dev --filter=fkt.openendurance.org |
Open fkt.openendurance.org NextJS site |
All workspaces
Run commands across all workspaces. This uses turbo run <command>
.
Command | Runs |
---|---|
yarn changeset |
Adds a new changelog entry |
yarn lint |
Lints all workspaces |
yarn test |
Tests all workspaces |
yarn type-check |
Build types and check for type errors |
yarn clean |
Remove generated files |
yarn format |
Format files with prettier |
We need your help! Pick something from the backlog or suggest a new feature. And pull requests are always welcome. See the contribution guidelines for more information.
Source code in this repository and related NPM packages are released under the MIT license.
Photos used in the docs are property of their respective owners (probably @kcargile) and are subject to copyright unless otherwise specified.