mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-11 21:12:16 +00:00
58 lines
2.5 KiB
Markdown
58 lines
2.5 KiB
Markdown
|
# ZITADEL typescript with Changesets
|
||
|
|
|
||
|
|
This is an monorepo containing all typescript/javascript packages and applications for ZITADEL powered by Turborepo. Versioning and package publishing is handled by [Changesets](https://github.com/changesets/changesets) and fully automated with GitHub Actions.
|
||
|
|
|
||
|
|
## What's inside?
|
||
|
|
|
||
|
|
This Turborepo includes the following:
|
||
|
|
|
||
|
|
### Apps and Packages
|
||
|
|
|
||
|
|
- `login`: The new login UI powered by Next.js
|
||
|
|
- `@zitadel/core`: core node SDK
|
||
|
|
- `@zitadel/react-utils`: shared React utilities
|
||
|
|
- `@zitadel/tsconfig`: shared `tsconfig.json`s used throughout the monorepo
|
||
|
|
- `eslint-config-zitadel`: ESLint preset
|
||
|
|
|
||
|
|
Each package and app is 100% [TypeScript](https://www.typescriptlang.org/).
|
||
|
|
|
||
|
|
### Utilities
|
||
|
|
|
||
|
|
This repo has some additional tools already setup for you:
|
||
|
|
|
||
|
|
- [TypeScript](https://www.typescriptlang.org/) for static type checking
|
||
|
|
- [ESLint](https://eslint.org/) for code linting
|
||
|
|
- [Prettier](https://prettier.io) for code formatting
|
||
|
|
|
||
|
|
### Useful commands
|
||
|
|
|
||
|
|
- `yarn build` - Build all packages and the docs site
|
||
|
|
- `yarn dev` - Develop all packages and the docs site
|
||
|
|
- `yarn lint` - Lint all packages
|
||
|
|
- `yarn changeset` - Generate a changeset
|
||
|
|
- `yarn clean` - Clean up all `node_modules` and `dist` folders (runs each package's clean script)
|
||
|
|
|
||
|
|
## Versioning and Publishing packages
|
||
|
|
|
||
|
|
Package publishing has been configured using [Changesets](https://github.com/changesets/changesets). Please review their [documentation](https://github.com/changesets/changesets#documentation) to familiarize yourself with the workflow.
|
||
|
|
|
||
|
|
This example comes with automated npm releases setup in a [GitHub Action](https://github.com/changesets/action). To get this working, you will need to create an `NPM_TOKEN` and `GITHUB_TOKEN` in your repository settings. You should also install the [Changesets bot](https://github.com/apps/changeset-bot) on your GitHub repository as well.
|
||
|
|
|
||
|
|
For more information about this automation, refer to the official [changesets documentation](https://github.com/changesets/changesets/blob/main/docs/automating-changesets.md)
|
||
|
|
|
||
|
|
### npm
|
||
|
|
|
||
|
|
If you want to publish package to the public npm registry and make them publicly available, this is already setup.
|
||
|
|
|
||
|
|
To publish packages to a private npm organization scope, **remove** the following from each of the `package.json`'s
|
||
|
|
|
||
|
|
```diff
|
||
|
|
- "publishConfig": {
|
||
|
|
- "access": "public"
|
||
|
|
- },
|
||
|
|
```
|
||
|
|
|
||
|
|
### GitHub Package Registry
|
||
|
|
|
||
|
|
See [Working with the npm registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#publishing-a-package-using-publishconfig-in-the-packagejson-file)
|