Skip to content

Commit 338cac5

Browse files
committed
docs: Update README
1 parent 5601143 commit 338cac5

File tree

1 file changed

+48
-13
lines changed

1 file changed

+48
-13
lines changed

README.md

Lines changed: 48 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,29 +32,63 @@ The tech stack is rather simple:
3232

3333
### Building and running
3434

35-
1. Clone the repo
35+
#### Using the Backend GraphQL API
3636

37-
```sh
38-
git clone https://github.com/rm3l/dev-feed && cd dev-feed
37+
##### Docker
38+
39+
A Docker repository with the GraphQL API Server can be found here: https://hub.docker.com/r/rm3l/dev-feed-api
40+
41+
To fetch the docker image, run:
42+
43+
```bash
44+
docker image pull rm3l/dev-feed-api
45+
```
46+
47+
To run the server with the default options and expose it on port 8080:
48+
49+
```bash
50+
docker container run --rm -p 8080:8080 rm3l/dev-feed-api
3951
```
4052

41-
2. Build the Backend
53+
You can then access the GraphiQL browser by heading to http://localhost:8080/graphiql
54+
55+
##### Kubernetes
56+
57+
The Backend API is also published to [my Helm Charts repository](https://helm-charts.rm3l.org/), so as to be deployable to a Kubernetes Cluster using [Helm](https://helm.sh/).
58+
59+
It is listed on Artifact Hub : https://artifacthub.io/packages/helm/rm3l/dev-feed
60+
61+
```bash
62+
$ helm repo add rm3l https://helm-charts.rm3l.org
63+
$ helm install my-dev-feed rm3l/dev-feed
64+
```
65+
66+
See https://artifacthub.io/packages/helm/rm3l/dev-feed or https://github.com/rm3l/helm-charts/blob/main/charts/dev-feed/README.md for
67+
all customizable values.
68+
69+
You can then access the GraphiQL browser by heading to http://localhost:8080/graphiql
70+
71+
##### Manual mode
72+
73+
1. Build the Backend
4274

4375
```sh
4476
./backend/gradlew -p ./backend build --stacktrace
4577
```
4678

47-
3. Run the Backend GraphQL API
79+
2. Run the Backend GraphQL API
4880

4981
```sh
5082
java -jar backend/api/build/libs/dev-feed-api-1.8.0.jar
5183
```
5284

5385
You can then access the GraphiQL browser by heading to http://localhost:8080/graphiql
5486

55-
4. Install Flutter by following the instructions on the [official website](https://flutter.dev/docs/get-started/install)
87+
#### Using the Mobile application
88+
89+
1. Install Flutter by following the instructions on the [official website](https://flutter.dev/docs/get-started/install)
5690

57-
5. Prepare the configuration environment
91+
2. Prepare the configuration environment
5892

5993
Skip this to use the default Heroku Backend. Otherwise, if you have a custom Backend (either local or remote), you need to create a specific environment file (say `my_personal_backend.dart`) in the `mobile/lib/environments` folder, e.g.:
6094

@@ -68,7 +102,7 @@ class MyPersonalBackend extends Env {
68102
}
69103
```
70104

71-
6. Build the mobile apps
105+
3. Build the mobile apps
72106

73107
First `cd` to the `mobile` directory:
74108

@@ -79,18 +113,18 @@ cd mobile
79113
If you simply want to target the default Heroku backend, just run:
80114

81115
```sh
82-
flutter build apk
116+
flutter build apk --debug
83117
```
84118

85119
Otherwise, if you have a custom Backend (and its related Dart environment file) declared under `mobile/lib/environments/my_personal_backend.dart`, then run:
86120

87121
```sh
88-
flutter build apk -t lib/environments/my_personal_backend.dart
122+
flutter build apk --debug -t lib/environments/my_personal_backend.dart
89123
```
90124

91-
You will then find the mobile applications built under the respective platform folders. For example, the APK for Android can be found under `build/app/outputs/apk/`.
125+
You will then find the mobile applications built under the respective platform folders. For example, the APK for Android can be found under `build/app/outputs/apk/debug/`.
92126

93-
7. Install and run the APK either in an emulator or in a real device
127+
4. Install and run the APK either in an emulator or in a real device
94128

95129
```sh
96130
flutter install
@@ -99,7 +133,7 @@ flutter install
99133
Or:
100134

101135
```sh
102-
adb install -r build/app/outputs/apk/app.apk
136+
adb install -r build/app/outputs/apk/debug/app-debug.apk
103137
```
104138

105139
## Contribution Guidelines
@@ -112,6 +146,7 @@ However, please make sure your description is clear enough and has sufficient in
112146

113147
## Credits / Inspiration
114148

149+
* [EngineeringBlogs.xyz](https://engineeringblogs.xyz/)
115150
* [DiscoverDev.io](https://www.discoverdev.io/)
116151

117152
## Developed by

0 commit comments

Comments
 (0)