Skip to content

Update CONTRIBUTING.md #5268

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

Merged
FeodorFitsner merged 1 commit into from
May 3, 2025
Merged

Update CONTRIBUTING.md #5268

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
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,24 +112,26 @@ It should work now.

Add the `FLET_VIEW_PATH` and `FLET_WEB_PATH` variables to the environment variables or profile scripts for your respective OS, making sure to modify the path accordingly:

- On macOS (in `~/.zprofile` or any other profile script):
- On macOS (in `~/.zprofile` or any other profile script)*:
```
# Flet
export FLET_VIEW_PATH="$HOME/{path-to-flet}/flet/client/build/macos/Build/Products/Release"
export FLET_WEB_PATH="$HOME/{path-to-flet}/flet/client/build/web"
```


- On Windows (open "System Properties" > "Environment Variables", then add a new environment variable):
- as "Variable name", enter `FLET_VIEW_PATH`, and as "Value", `{path-to-flet}\flet\client\build\windows\x64\runner\Release`
- as "Variable name", enter `FLET_WEB_PATH`, and as "Value", `{path-to-flet}\flet\client\build\web`

- On Linux (in `~/.bash_profile` or any other profile script):
- On Linux (in `~/.bash_profile` or any other profile script)*:
```
# Flet
export FLET_VIEW_PATH="$HOME/{path-to-flet}/flet/client/build/linux/{arch}/release/bundle"
export FLET_WEB_PATH="$HOME/{path-to-flet}/flet/client/build/web"
```


If you have Microsoft Edge installed and want to use it for debugging Flutter apps:

```
Expand All @@ -139,6 +141,8 @@ export CHROME_EXECUTABLE="/Applications/Microsoft Edge.app/Contents/MacOS/Micros

If you added these through the terminal, close that terminal session and create a new one.

\* <small>if continuing in the same shell run `source ~/.zprofile` to activate variables in current session</small>

### Building the Flutter client
Open an instance of your IDE (preferably VS Code) at the `flet-dev/flet/client` directory.

Expand Down Expand Up @@ -279,4 +283,4 @@ Set PATH:
echo 'export PATH=$HOME/fvm/default/bin:$PATH' >> ~/.zprofile
```

* **cocoapods**: https://guides.cocoapods.org/using/getting-started.html#installation
* **cocoapods**: https://guides.cocoapods.org/using/getting-started.html#installation