Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update contributing.md #45

Merged
merged 1 commit into from
Feb 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Contributions are always welcome, no matter how large or small!

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the [code of conduct](./CODE_OF_CONDUCT.md).

Open issues for things to work on!

## Development workflow

This project is a monorepo managed using [Yarn workspaces](https://yarnpkg.com/features/workspaces). It contains the following packages:
Expand All @@ -29,6 +31,25 @@ To edit the Java or Kotlin files, open `example/android` in Android studio and f

You can use various commands from the root directory to work with the project.

Before running the examples you must build the editor
To build the editor:

```sh
yarn editor:build
```

If you are working on the web side of the editor and you want to have hot reload enabled you need to do the following

1. run `yarn editor:dev`
2. inside `useEditorBridge` set `DEV: true`

```tsx
const editor = useEditorBridge({
DEV: true,
DEV_SERVER_URL: 'http://locahost:1234', // (OPTIONAL) - if the dev server is running on a different port
});
```

To start the packager:

```sh
Expand Down Expand Up @@ -131,6 +152,8 @@ yarn release
The `package.json` file contains various scripts for common tasks:

- `yarn`: setup project by installing dependencies.
- `yarn editor:build`: build the editor
- `yarn editor:dev`: run the editor dev server
- `yarn typecheck`: type-check files with TypeScript.
- `yarn lint`: lint files with ESLint.
- `yarn test`: run unit tests with Jest.
Expand Down
Loading