Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 1.46 KB

README.md

File metadata and controls

80 lines (53 loc) · 1.46 KB

Flutter Client for Dalal Street

Prerequisites

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