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.

Sign up for GitHub

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

Jump to bottom

docs: local setup notes #5974

Merged
merged 1 commit into from
Jun 30, 2024
Merged

docs: local setup notes #5974

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,36 @@ We welcome any type of contribution, not only code. Like for example:
- **Money**: We welcome financial contributions in full transparency on our [Open Collective].


## Setting up the repository

This is a Node.js project and you need to have Node.js installed on your machine. You can download it from [here](https://nodejs.org/). We test versions 14 and 16 of Node in the CI, so it's recommended to use one of these versions, or the latest of: 16.20.2

```bash
nvm use 16.20.2
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RE discussion, we should use this version locally to ensure consistent machine to CI.

16.20.2 comes from the latest 16 in https://nodejs.org/en/about/previous-releases and satisfies the node-version: [14.17, 16.x] matrix in the CI test runner.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙇‍♂️
Based on the releases, we should probably switch to [20.x, 22.x] soon.

```

You will then use `yarn` to manage the dependencies and run the scripts. You can install it by running:

```bash
npm install -g yarn
```

Then you can clone the repository and install the dependencies:

```bash
git clone __YOUR_FORK__
cd grapesjs
yarn
```

Finally, you can run the development server:

```bash
yarn start
```

Navigate to `http://localhost:8080/` to see the editor in action. The development server will watch for changes in the code and automatically reload the page.

## Your First Contribution

Working on your first Pull Request? You can learn how from this **free** series, [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
Expand Down
Loading