Skip to content

Commit f716dbd

Browse files
committed
Runs build workflow locally and improves readme
1 parent b1f0004 commit f716dbd

File tree

21 files changed

+70
-55
lines changed

21 files changed

+70
-55
lines changed

.github/workflows/dispatch.yml

Lines changed: 0 additions & 19 deletions
This file was deleted.

.github/workflows/dispatch_draft.yml

Lines changed: 0 additions & 19 deletions
This file was deleted.
Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
1+
name: Build
12
on:
23
push:
34

4-
name: Build
55
jobs:
66
linux:
7-
name: Android
87
runs-on: ubuntu-latest
98
steps:
9+
- name: Checkout bookkeeping app
10+
uses: actions/checkout@v2
11+
with:
12+
path: 'app'
13+
14+
- name: Checkout credentials repo
15+
uses: actions/checkout@v2
16+
with:
17+
repository: hemanta212/personal
18+
token: ${{ secrets.REPO_ACCESS_TOKEN }}
19+
ref: "master"
20+
path: 'personal'
21+
1022
- run: |
1123
git clone https://github.com/flutter/flutter.git
1224
cd flutter
@@ -16,12 +28,10 @@ jobs:
1628
with:
1729
java-version: '12.x'
1830

19-
- uses: actions/checkout@v2
20-
with:
21-
path: 'app'
22-
2331
- run: |
2432
cd app
33+
cp ../personal/credentials/inventory_flutter/google-services.json android/app/
34+
2535
flutter pub get
2636
flutter build apk
2737
mkdir build/app/outputs/apk/app_release
@@ -38,5 +48,6 @@ jobs:
3848
app/build/app/outputs/apk/release/app-x86_64-release.apk
3949
app/build/app/outputs/apk/app_release/app-release.apk
4050
body_path: app/CHANGELOG.txt
51+
tag_name: ${{ github.event.client_payload.version }}
4152
env:
4253
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 53 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,66 @@
1-
# Inventory management and bookkeeping app
2-
A practical approach to bookeeping in retail or small business.
1+
# Inventory management app
2+
A simple approach to inventory management in retail or small business.
33
This app is focused on making the sales entry, stock entry as fast as practically possible.
44

5-
![Build](https://github.com/hemanta212/hello_flutter/workflows/Bookkeeping_app/badge.svg)
5+
![Build](https://github.com/hemanta212/inventory_app/workflows/Build/badge.svg)
66

77
## App overview
8-
8+
<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" />
9+
<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" />
10+
<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" />
11+
<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" />
12+
<img src="images/17.png" width="280"/>
913

1014
## Project Installation:
11-
### 1. Building yourself
1215

13-
* First Install flutter : [Flutter Installation](https://flutter.dev/docs/get-started/install)
16+
### 1. Install and try out the apk!
17+
Head over to the release page to try out the apps. [APK Releases](https://github.com/hemanta212/inventory_app/releases/latest)
18+
19+
### 2. Building yourself
20+
21+
#### 1. Get Flutter
22+
* Install flutter : [Flutter Installation](https://flutter.dev/docs/get-started/install)
23+
24+
#### 2. Clone this repo
25+
```
26+
$ git clone https://github.com/hemanta212/inventory_app.git
27+
$ cd inventory_app
28+
```
29+
30+
#### 3. Setup the firebase app
31+
32+
1. You'll need to create a Firebase instance. Follow the instructions at https://console.firebase.google.com.
33+
2. Once your Firebase instance is created, you'll need to enable Google authentication.
34+
35+
* Go to the Firebase Console for your new instance.
36+
* Click "Authentication" in the left-hand menu
37+
* Click the "sign-in method" tab
38+
* Click "Google" and enable it
39+
40+
3. Enable the Firebase Database
41+
* Go to the Firebase Console
42+
* Click "Database" in the left-hand menu
43+
* Click the Cloudstore "Create Database" button
44+
* Select "Start in test mode" and "Enable"
45+
46+
4. (skip if not running on Android)
47+
* Create an app within your Firebase instance for Android, with package name com.yourcompany.news
48+
* Run the following command to get your SHA-1 key:
49+
50+
```
51+
keytool -exportcert -list -v \
52+
-alias androiddebugkey -keystore ~/.android/debug.keystore
53+
```
54+
55+
* In the Firebase console, in the settings of your Android app, add your SHA-1 key by clicking "Add Fingerprint".
56+
* Follow instructions to download google-services.json
57+
* place `google-services.json` into `/android/app/`.
58+
59+
#### 4. Run
60+
Connect your device
1461

1562
```
16-
$ git clone https://github.com/hemanta212/bookkeeping_app.git
17-
$ cd bookkeeping_app
1863
$ flutter upgrade
1964
$ flutter pub get
2065
$ flutter run
2166
```
22-
23-
### 2. Install and try out the apk!
24-
Head over to the release page to try out the apps. [APK Releases](https://github.com/hemanta212/bookkeeping_app/releases/latest)

images/1.png

48.8 KB
Loading

images/10.png

67.6 KB
Loading

images/11.png

65 KB
Loading

images/12.png

27.9 KB
Loading

images/13.png

30.2 KB
Loading

images/14.png

54 KB
Loading

0 commit comments

Comments
 (0)