Skip to content

Commit dc1a378

Browse files
docs(tools): update doc using the setup file
1 parent 6acd4e4 commit dc1a378

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
11
# flutter_policy_engine
2+
23
flutter_policy_engine is a lightweight and extensible policy engine for Flutter that lets you define, manage, and evaluate access control rules declaratively using ABAC (Attribute-Based Access Control) or RBAC models.
4+
5+
## Installation
6+
7+
Make sure you have [Flutter](https://docs.flutter.dev/get-started/install) and [Dart](https://dart.dev/get-dart) installed. It is recommended to use [FVM](https://fvm.app/) for Flutter version management.
8+
9+
```bash
10+
# Clone the repository and enter the directory
11+
# git clone <repo-url>
12+
cd flutter_policy_engine
13+
14+
# Run the setup script (requires bash, Flutter, Node.js, and npm)
15+
./setup.sh
16+
```
17+
18+
The setup script will:
19+
20+
- Check for Flutter and FVM installation
21+
- Install the Flutter version defined in `.fvm/fvm_config.json` (if present)
22+
- Install Dart/Flutter dependencies (`pub get`)
23+
- Install Node.js dependencies (if `package.json` exists)
24+
- Initialize Husky for git hooks (if present)
25+
- Add `.fvm/` to `.gitignore` if needed
26+
27+
## Scripts & Tooling
28+
29+
- `./setup.sh`: Automates environment setup.
30+
- `fvm flutter test` or `flutter test`: Runs tests.
31+
- Husky and Commitlint are set up for commit quality (requires Node.js).
32+
33+
## Linting
34+
35+
This project uses [flutter_lints](https://pub.dev/packages/flutter_lints) to enforce good coding practices. You can customize rules in `analysis_options.yaml`.
36+
37+
## License
38+
39+
MIT © 2025 David Alejandro Garcia Ruiz
40+
41+
---
42+
43+
> If you use VSCode, restart your terminal after setup to ensure FVM is properly detected.

0 commit comments

Comments
 (0)