- Flutter >2.12 Download Link
- Protocol Buffer Compiler Download Link
-
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
- Install the protocol compiler plugin for Dart (
-
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
-
- 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