delta / dalal-street-client

Cross Platform(Android & Web) client for Dalal Street

https://play.google.com/store/apps/details?id=org.pragyan.dalal18

12 stars 6 forks source link

bloc cross-platform dalal-street flutter grpc pragyan protocol-buffers responsive-design rxdart stock-market streams

readme

Flutter Client for Dalal Street

Prerequisites

Flutter >2.12 Download Link
Protocol Buffer Compiler Download Link

Check Prerequisites

Run if you have installed all the required flutter dependencies with
```
flutter doctor -v
```
Ensure protoc compiler version is 3+
```
protoc --version
```
Dart plugin for the protocol compiler
- Install the protocol compiler plugin for Dart (protoc-gen-dart)
```
flutter pub global activate protoc_plugin
```
- Update PATH so that the protoc compiler can find the plugin

Setup

Clone the repository

git clone https://github.com/delta/dalal-street-client.git

Install dependencies
```
flutter pub get
```
Setup submodules
```
git submodule init
git submodule update
```
configure git-hooks path
```
git config core.hooksPath .githooks
```
Generate proto files
```
./build_proto.sh
```
Run App
- Run cp config.example.json config.json
- Fill in the app configuration(host, port etc) in config.json.
- Connect your device and run
```
flutter run
```

Dev Guidelines

For each feature proper Tests should be written before creating pull requests
Comment as much as possible
Please follow this format [type]:commit message for committing your code.
Example [feat]: Initial Commit