mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-12 22:33:34 +00:00
91 lines
3.2 KiB
Markdown
91 lines
3.2 KiB
Markdown
# Contributing
|
|
|
|
:attention: In this CONTRIBUTING.md you read about contributing to this very repository.
|
|
If you want to develop your own login UI, please refer [to the README.md](./README.md).
|
|
|
|
## Introduction
|
|
|
|
Thank you for your interest about how to contribute!
|
|
|
|
:attention: If you notice a possible **security vulnerability**, please don't hesitate to disclose any concern by contacting [security@zitadel.com](mailto:security@zitadel.com).
|
|
You don't have to be perfectly sure about the nature of the vulnerability.
|
|
We will give them a high priority and figure them out.
|
|
|
|
We also appreciate all your other ideas, thoughts and feedback and will take care of them as soon as possible.
|
|
We love to discuss in an open space using [GitHub issues](https://github.com/zitadel/typescript/issues),
|
|
[GitHub discussions in the core repo](https://github.com/zitadel/zitadel/discussions)
|
|
or in our [chat on Discord](https://zitadel.com/chat).
|
|
For private discussions,
|
|
you have [more contact options on our Website](https://zitadel.com/contact).
|
|
|
|
## Pull Requests
|
|
|
|
Please consider the following guidelines when creating a pull request.
|
|
|
|
- The latest changes are always in `main`, so please make your pull request against that branch.
|
|
- pull requests should be raised for any change
|
|
- üull requests need approval of a ZITADEL core engineer @zitadel/engineers before merging
|
|
- We use ESLint/Prettier for linting/formatting, so please run `pnpm lint:fix` before committing to make resolving conflicts easier (VSCode users, check out [this ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [this Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) to fix lint and formatting issues in development)
|
|
- If you add new functionality, please provide the corresponding documentation as well and make it part of the pull request
|
|
|
|
## Setting Up The ZITADEL API
|
|
|
|
If you want to have a one-liner to get you up and running,
|
|
or if you want to develop against a ZITADEL API with the latest features,
|
|
or even add changes to ZITADEL itself at the same time,
|
|
you should develop against your local ZITADEL process.
|
|
However, it might be easier to develop against your ZITADEL Cloud instance
|
|
if you don't have docker installed
|
|
or have limited resources on your local machine.
|
|
|
|
### Developing Against Your Local ZITADEL Instance
|
|
|
|
|
|
|
|
### Developing Against Your ZITADEL Cloud Instance
|
|
|
|
|
|
### Setting up local environment
|
|
|
|
This guide assumes you develop against a local ZITADEL instance using docker compose.
|
|
If you want to develop against
|
|
|
|
A quick guide on how to setup your ZITADEL typescript app locally to work on it and test out any changes:
|
|
|
|
1. Clone the repo:
|
|
|
|
```sh
|
|
git clone https://github.com/zitadel/typescript.git
|
|
cd typescript
|
|
```
|
|
|
|
3. Install packages. Developing requires Node.js v16:
|
|
|
|
```sh
|
|
pnpm install
|
|
```
|
|
|
|
4. Populate `.env.local`:
|
|
|
|
Copy `/apps/login/.env` to `/apps/login/.env.local`, and add your instance env variables for each entry.
|
|
|
|
```sh
|
|
cp apps/login/.env apps/login/.env.local
|
|
```
|
|
|
|
5. Generate GRPC stub for the application:
|
|
|
|
```sh
|
|
pnpm generate
|
|
```
|
|
|
|
6. Start the developer application/server:
|
|
|
|
```sh
|
|
pnpm dev
|
|
```
|
|
|
|
The application is now available at `http://localhost:3000`
|
|
|
|
That's it! 🎉
|