🎉 adds README.md docs

.github/pull_request_template.md

@@ -0,0 +1,47 @@
+### Type
+- [ ] Feature
+- [ ] Bug
+- [ ] Enhancement
+- [ ] Chore
+
+### Status
+- [ ] Work In Progress
+- [ ] Completed
+- [ ] In Review
+
+### Checks
+- [ ] I have run `./gradlew build` or build and it passed successfully
+- [ ] I have run `./gradlew check` or tests and all have passed successfully
+- [ ] I have tested the app on a physical device and it works as intended
+
+### Previous Behaviour
+> what is the current behaviour of what was being worked on
+
+None
+
+### Current Behaviour
+> what is the current behaviour of what was being worked on
+
+None
+
+### Intended Behaviour
+> what is the intended behaviour of what was being worked on
+
+None
+
+### Closes Issues
+> issue number of what was being worked on (__if necessary__)
+
+None
+
+[//]: # (`fixes #1` or `closes #1`)
+
+### Notes
+> additional information of what was being worked on (__if necessary__)
+
+None
+
+### Screenshot
+> an image of what was being worked on (__if necessary__)
+
+None

.github/workflows/build.yml

@@ -0,0 +1,25 @@
+name: Build Gradle project
+on: push
+jobs:
+  build-gradle-project:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project sources
+        uses: actions/checkout@v2
+      - name: Create local.properties file
+        run: |
+          touch local.properties
+          echo "add things you want in your local file here"
+      - name: TODO to Issue
+        uses: alstr/[email protected]
+        id: todo
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          cache: 'gradle'
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+      - name: Run build with Gradle Wrapper
+        run: ./gradlew build

.github/workflows/check.yml

@@ -0,0 +1,32 @@
+name: Build Gradle project
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build-gradle-project:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project sources
+        uses: actions/checkout@v2
+      - name: Create local.properties file
+        run: |
+          touch local.properties
+          echo "add things you want here"
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          cache: 'gradle'
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+      - name: Run build with Gradle Wrapper
+        run: ./gradlew build
+      - name: Run tests with Gradle Wrapper
+        run: ./gradlew check

README.md

@@ -0,0 +1,4 @@
+<p align="center"><img width=100% src="/.github/images/template-android.png" alt="Ding Logo"></p>
+
+# Template (Android)
+This is a simple android template