Skip to content
Merged
Show file tree
Hide file tree
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
33 changes: 32 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,12 @@ Install [pixi](https://github.com/prefix-dev/pixi) to manage your development en
> Note that developing in Gitpod is not officially supported by the marimo team.

```bash
pixi run hatch shell
pixi shell
```

If you have the right non-python dependencies installed via other methods (e.g. homebrew) you can simply activate your `marimo` development
environment with `hatch shell`.

Now you can install the environment frontend and Python dependencies.

```bash
Expand All @@ -45,18 +48,46 @@ After doing this, you can instantiate your marimo development environment by run
make dev
```

This will launch two processes, the backend one in port 2718 and the front end one in port 3000.

In summary you will need to run:

```bash
pixi shell
make fe && make py
make dev
```

or if not using `pixi`:

```bash
hatch shell
make fe && make py
make dev
```

### `pre-commit` hooks

You can optionally install [pre-commit](https://pre-commit.com/) hooks to automatically run the validation checks when making a commit:

```bash
uvx pre-commit install
```

or

```bash
pixi run pre-commit install
```

To build the frontend unminified, run:

```bash
NODE_ENV=development make fe -B
```



## `make` commands

> [!NOTE]
Expand Down
49 changes: 49 additions & 0 deletions pixi.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -579,3 +579,6 @@ pre_commit = ">=4.2.0,<5"
uv = ">=0.6.12,<0.7"
python = "3.12.*"
pip = ">=25.0.1,<26"

[tool.pixi.pypi-dependencies]
marimo = {path = ".", editable = true}