Skip to content

Commit eadb251

Browse files
committed
docs: add package testing documentation to README
1 parent efe8e5d commit eadb251

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,32 @@ To install on a locally developed app:
2121
path: <your-path-to-the-local-supabase-flutter-repo>/packages/supabase_flutter
2222
```
2323
24+
## Testing
25+
26+
The tests for the packages `postgrest`, `gotrue` and `storage_client` need some Supabase services running.
27+
To run these tests locally, you need to have the `docker` cli with `docker-compose` installed.
28+
29+
The needed configuration for starting the services are in the `infra` directory.
30+
31+
To start the services change working directory to `infa/<package>` and run the following command:
32+
33+
```bash
34+
docker compose up -d
35+
```
36+
37+
Run the Dart tests within the package directory in `packages/<package>` with the following command:
38+
The `-j 1` flag runs the tests not concurrently, which works better since the tests are running against the same services.
39+
40+
```bash
41+
dart test -j 1
42+
```
43+
44+
To stop the services run the following command in the `infra/<package>` directory:
45+
46+
```bash
47+
docker compose down
48+
```
49+
2450
## Contributing
2551

2652
- Fork the repo on [GitHub](https://github.com/supabase/supabase-flutter)

0 commit comments

Comments
 (0)