Skip to content

Commit

Permalink
Add more info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jogboms committed Jul 3, 2023
1 parent f88a6a4 commit 78054a3
Showing 1 changed file with 41 additions and 2 deletions.
43 changes: 41 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,44 @@ TailorMade is what actually started out as an experiment with [Flutter](https://

> For a full description of OSS used, see pubspec.yaml
## Getting Started

After cloning,

### FVM setup

Install `fvm` if not already installed.

```bash
dart pub global activate fvm
```

Install local `flutter` version.

```bash
fvm install
```

### Install, L10n & Riverpod code generation

```bash
fvm flutter pub get
fvm flutter pub run build_runner build
```

## Running

There are three (3) available environments:
- `mock`: Demo mode with non-persistent data
- `dev`: Development mode connected to firebase dev instance
- `prod`: Production mode connected to firebase production instance

To run in `mock` mode,

```bash
fvm flutter run --flavor mock --dart-define=env.mode=mock
```

## UI Shots

<div style="text-align: center">
Expand Down Expand Up @@ -101,5 +139,6 @@ TailorMade is what actually started out as an experiment with [Flutter](https://
</table>
</div>

For help getting started with Flutter, view our online
[documentation](https://flutter.io/).
## License

MIT License

0 comments on commit 78054a3

Please sign in to comment.