Runs build workflow locally and improves readme

hemanta212 · May 25, 2020 · f716dbd · f716dbd
1 parent b1f0004
commit f716dbd
Show file tree

Hide file tree

Showing 21 changed files with 70 additions and 55 deletions.
diff --git a/.github/workflows/dispatch.yml b/.github/workflows/dispatch.yml
diff --git a/.github/workflows/dispatch_draft.yml b/.github/workflows/dispatch_draft.yml
diff --git a/.github/workflows/main.yml-old → .github/workflows/main.yml b/.github/workflows/main.yml-old → .github/workflows/main.yml
@@ -1,12 +1,24 @@
+name: Build
 on:
   push:
 
-name: Build
 jobs:
   linux:
-    name: Android
     runs-on: ubuntu-latest
     steps:
+      - name: Checkout bookkeeping app
+        uses: actions/checkout@v2
+        with:
+          path: 'app'
+
+      - name: Checkout credentials repo
+        uses: actions/checkout@v2
+        with:
+          repository: hemanta212/personal
+          token: ${{ secrets.REPO_ACCESS_TOKEN }}
+          ref: "master"
+          path: 'personal'
+
       - run: |
           git clone https://github.com/flutter/flutter.git
           cd flutter
@@ -16,12 +28,10 @@ jobs:
         with:
           java-version: '12.x'
 
-      - uses: actions/checkout@v2
-        with:
-          path: 'app'
-
       - run: |
           cd app
+          cp ../personal/credentials/inventory_flutter/google-services.json android/app/
+
           flutter pub get
           flutter build apk
           mkdir build/app/outputs/apk/app_release
@@ -38,5 +48,6 @@ jobs:
             app/build/app/outputs/apk/release/app-x86_64-release.apk
             app/build/app/outputs/apk/app_release/app-release.apk
           body_path: app/CHANGELOG.txt
+          tag_name: ${{ github.event.client_payload.version }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
@@ -1,24 +1,66 @@
-# Inventory management and bookkeeping app
-A practical approach to bookeeping in retail or small business.
+# Inventory management app
+A simple approach to inventory management in retail or small business.
 This app is focused on making the sales entry, stock entry as fast as practically possible.
 
-![Build](https://github.com/hemanta212/hello_flutter/workflows/Bookkeeping_app/badge.svg)
+![Build](https://github.com/hemanta212/inventory_app/workflows/Build/badge.svg)
 
 ## App overview
-
+<img src="images/1.png" width="280"/> <img src="images/2.png" width="280"/> <img src="images/3.png" width="280" /><img src="images/4.png" width="280" />
+<img src="images/5.png" width="280"/> <img src="images/6.png" width="280"/> <img src="images/7.png" width="280" /><img src="images/8.png" width="280" />
+<img src="images/9.png" width="280"/> <img src="images/10.png" width="280"/> <img src="images/11.png" width="280" /><img src="images/12.png" width="280" />
+<img src="images/13.png" width="280"/> <img src="images/14.png" width="280"/> <img src="images/15.png" width="280" /><img src="images/16.png" width="280" />
+<img src="images/17.png" width="280"/>
 
 ## Project Installation:
-### 1. Building yourself
 
-* First Install flutter : [Flutter Installation](https://flutter.dev/docs/get-started/install)
+### 1. Install and try out the apk!
+Head over to the release page to try out the apps. [APK Releases](https://github.com/hemanta212/inventory_app/releases/latest)
+
+### 2. Building yourself
+
+#### 1. Get Flutter
+* Install flutter : [Flutter Installation](https://flutter.dev/docs/get-started/install)
+
+#### 2. Clone this repo
+```
+$ git clone https://github.com/hemanta212/inventory_app.git
+$ cd inventory_app
+```
+
+#### 3. Setup the firebase app
+
+1. You'll need to create a Firebase instance. Follow the instructions at https://console.firebase.google.com.
+2. Once your Firebase instance is created, you'll need to enable Google authentication.
+
+* Go to the Firebase Console for your new instance.
+* Click "Authentication" in the left-hand menu
+* Click the "sign-in method" tab
+* Click "Google" and enable it
+
+3. Enable the Firebase Database
+* Go to the Firebase Console
+* Click "Database" in the left-hand menu
+* Click the Cloudstore "Create Database" button
+* Select "Start in test mode" and "Enable"
+
+4. (skip if not running on Android)
+* Create an app within your Firebase instance for Android, with package name com.yourcompany.news
+* Run the following command to get your SHA-1 key:
+
+```
+keytool -exportcert -list -v \
+-alias androiddebugkey -keystore ~/.android/debug.keystore
+```
+
+* In the Firebase console, in the settings of your Android app, add your SHA-1 key by clicking "Add Fingerprint".
+* Follow instructions to download google-services.json
+* place `google-services.json` into `/android/app/`.
+
+#### 4. Run
+Connect your device 
 
 ```
-$ git clone https://github.com/hemanta212/bookkeeping_app.git
-$ cd bookkeeping_app
 $ flutter upgrade
 $ flutter pub get
 $ flutter run
 ```
-
-### 2. Install and try out the apk!
-Head over to the release page to try out the apps. [APK Releases](https://github.com/hemanta212/bookkeeping_app/releases/latest)
diff --git a/images/1.png b/images/1.png
diff --git a/images/10.png b/images/10.png
diff --git a/images/11.png b/images/11.png
diff --git a/images/12.png b/images/12.png
diff --git a/images/13.png b/images/13.png
diff --git a/images/14.png b/images/14.png
diff --git a/images/15.png b/images/15.png
diff --git a/images/16.png b/images/16.png
diff --git a/images/17.png b/images/17.png
diff --git a/images/2.png b/images/2.png
diff --git a/images/3.png b/images/3.png
diff --git a/images/4.png b/images/4.png
diff --git a/images/5.png b/images/5.png
diff --git a/images/6.png b/images/6.png
diff --git a/images/7.png b/images/7.png
diff --git a/images/8.png b/images/8.png
diff --git a/images/9.png b/images/9.png