https://github.com/leather-io/mono
Leather monorepo
https://github.com/leather-io/mono
Last synced: 3 months ago
JSON representation
Leather monorepo
- Host: GitHub
- URL: https://github.com/leather-io/mono
- Owner: leather-io
- License: mit
- Created: 2023-09-14T09:07:01.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2025-02-06T17:50:50.000Z (3 months ago)
- Last Synced: 2025-02-06T18:04:49.145Z (3 months ago)
- Language: TypeScript
- Homepage: https://leather.io
- Size: 59.2 MB
- Stars: 14
- Watchers: 4
- Forks: 6
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Leather Mono
The purpose of this monorepo is to provide a single home for core Leather functionality. The monorepo uses [`pnpm` workspaces](https://pnpm.io/workspaces) and [Turborepo](https://turbo.build/repo/docs). Packages are found under `packages/*`. Apps are found under `apps/*`.
## Installation
1. `pnpm i` at the `mono` root
2. Run `pnpm build`
## Architecture
- [Architecture](docs/core/ARCHITECTURE.md)
- [Monorepo](docs/core/MONOREPO.md)
Coding standards are enforced through the use of
- `eslint`
- `prettier`
- `typescript`
- `syncpack`
- `ls-lint`
### Monorepo core packages
The current packages are listed below
- [ESLint](packages/eslint-config/README.md)
- [Prettier](packages/prettier-config/README.md)
- [TSconfig](packages/tsconfig-config/README.md)
## Running code quality checks with git hooks
Configure code checks to run during pre-commit and/or pre-push hooks. Each check maps directly to a script in the root package.json.
1. Copy `.env.example` to `.env`.
2. Enable specific checks for each hook::
```
PRE_COMMIT=format,lint
PRE_PUSH=syncpack:lint,typecheck,lint:filenames
```
In most cases, setting PRE_COMMIT is sufficient, as errors from remaining checks are
uncommon, and typechecking is handled by editors.
Local checks are optional and configurable to suit developer preferences. On GitHub, these
checks run automatically on every push through [Code checks](.github/workflows/code-checks.yml), as part of the CI workflow.
### Documentation
Documentation has been provided from the outset and can be found in `docs/tools/` along with a [TEMPLATE.md](docs/core/TEMPLATE.md) file
### Development with extension
To be able to develop packages and test those in extension, check out this [guide](docs/extension-development.md)
## License
[MIT](LICENSE) © [Leather Wallet LLC](https://github.com/leather-io/mono)