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

Add mac dev guide #576

Merged
merged 4 commits into from
Jan 21, 2022
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
42 changes: 41 additions & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,44 @@ You should have docker installed in your system, if not click [here](https://doc
docker exec diagrams ./autogen.sh
```

6. If the unit tests and the bash script `autogen.sh` is working correctly, then your system is now ready for development.
6. If the unit tests and the bash script `autogen.sh` is working correctly, then your system is now ready for development.


## Mac local development setup

To be able to develop and run diagrams locally on you Mac device, you should have [Python](https://www.python.org/downloads/), [Go](https://golang.org/doc/install) and [brew](https://brew.sh/) installed on your system.

1. Go to diagrams root directory.

2. Install poetry, the Python project management packge used by diagrams.

```shell
pip install poetry
```

3. Install the project's Python dependencies.

```shell
poetry install
```

4. Install diagrams binary dependencies.

```shell
brew install imagemagick inkscape black
go get github.com/mingrammer/round
```

5. Run unit tests to confirm that it's working.

```shell
python -m unittest tests/*.py -v
```

6. Run the bash script `autogen.sh` to test.

```shell
./autogen.sh
```

7. If the unit tests and the bash script `autogen.sh` is working correctly, then your system is now ready for development.