Dev to Main

.github/workflows/_build.yml

@@ -0,0 +1,31 @@
+name: Build
+
+on:
+ workflow_call:
+
+jobs:
+ build:
+ name: Build ${{ matrix.target }}
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+ matrix:
+ target: [web] #TODO: Add android, ios, linux, macos, windows.
+ steps:
+ - name: Set up JDK 11
+ uses: actions/setup-java@v3
+ with:
+ java-version: 11
+ distribution: temurin
+ # Set up Flutter.
+ - name: Set up Flutter
+ uses: subosito/flutter-action@v2
+ with:
+ # flutter-version: '' TODO: Pin this to a version.
+ channel: stable
+ - run: flutter doctor -v
+ - name: Checkout
+ uses: actions/checkout@v3
+ - run: flutter pub get
+ - run: flutter packages pub run build_runner build --delete-conflicting-outputs
+ - run: flutter build ${{ matrix.target }}

.github/workflows/_docker_publish_private.yml

@@ -0,0 +1,66 @@
+name: Publish Docker Images (Private)
+
+on:
+ workflow_call:
+ inputs:
+ registry-auth-location:
+ description: 'Name of the GCP managed Artifact Registry.'
+ default: "us-central1-docker.pkg.dev"
+ required: false
+ type: string
+ remote-docker-image:
+ description: 'Remote Docker image. ex: toplprotocol/faucet'
+ default: "us-central1-docker.pkg.dev/topl-shared-project-dev/topl-artifacts-dev/faucet"
+ required: false
+ type: string
+
+jobs:
+ publish_docker_images:
+ name: Publish Docker Images
+ runs-on: ubuntu-latest
+ permissions:
+ id-token: write
+ contents: read
+ steps:
+ - name: Checkout current branch
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+ submodules: true
+
+ - id: 'auth'
+ name: Authenticate to Google Cloud
+ uses: google-github-actions/auth@v1
+ with:
+ workload_identity_provider: ${{ secrets.GCP_OIDC_PROVIDER_NAME }}
+ service_account: ${{ secrets.GCP_OIDC_SERVICE_ACCOUNT_EMAIL }}
+
+ - name: Set up gcloud
+ uses: google-github-actions/setup-gcloud@v1
+
+ - name: Auth Artifact Registry
+ run: gcloud auth configure-docker ${{ inputs.registry-auth-location }} --quiet
+
+ - name: Extract metadata (tags, labels) for Docker
+ id: meta
+ uses: docker/[email protected]
+ with:
+ images: ${{ inputs.remote-docker-image }}
+ tags: |
+ type=ref,event=branch
+ type=ref,event=tag
+ type=ref,event=pr
+ type=sha,enable=true,prefix=,
+
+ - name: Echo metadata
+ run: |
+ echo "tags: ${{ steps.meta.outputs.tags }}"
+ echo "labels: ${{ steps.meta.outputs.labels }}"
+
+ - name: Build and push Docker image
+ uses: docker/[email protected]
+ with:
+ context: .
+ push: ${{ github.event_name != 'pull_request' }}
+ tags: ${{ steps.meta.outputs.tags }}
+ labels: ${{ steps.meta.outputs.labels }}

.github/workflows/_docker_publish_public.yml

@@ -0,0 +1,57 @@
+name: Publish Docker Images (Public)
+
+on:
+ workflow_call:
+ inputs:
+ remote-docker-image:
+ description: 'Remote Docker image. ex: toplprotocol/faucet'
+ default: "toplprotocol/faucet"
+ required: false
+ type: string
+
+jobs:
+ publish_docker_images:
+ name: Publish Docker Images
+ runs-on: ubuntu-latest
+ permissions:
+ id-token: write
+ contents: read
+ packages: write
+ steps:
+ - name: Checkout current branch
+ uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+ submodules: true
+
+ - name: Log in to Docker Hub
+ uses: docker/login-action@v2
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+ - name: Log in to the Github Container registry
+ uses: docker/login-action@v2
+ with:
+ registry: ghcr.io
+ username: ${{ github.actor }}
+ password: ${{ secrets.GITHUB_TOKEN }}
+
+ - name: Extract metadata (tags, labels) for Docker
+ id: meta
+ uses: docker/[email protected]
+ with:
+ images: ${{ inputs.remote-docker-image }}
+
+ - name: Echo metadata
+ run: |
+ echo "tags: ${{ steps.meta.outputs.tags }}"
+ echo "labels: ${{ steps.meta.outputs.labels }}"
+
+ - name: Build and push Docker image
+ uses: docker/[email protected]
+ with:
+ context: .
+ push: ${{ github.event_name != 'pull_request' }}
+ tags: ${{ steps.meta.outputs.tags }}
+ labels: ${{ steps.meta.outputs.labels }}

.github/workflows/pr.yml

@@ -0,0 +1,7 @@
+name: PR
+on:
+ pull_request:
+
+jobs:
+ build:
+ uses: ./.github/workflows/_build.yml

.github/workflows/push.yml

@@ -0,0 +1,27 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: CI
+
+on:
+ push:
+ branches:
+ - main
+ - dev
+
+jobs:
+ build:
+ uses: ./.github/workflows/_build.yml 
+
+ publish_private:
+ uses: ./.github/workflows/_docker_publish_private.yml
+ needs: [build]
+ secrets: inherit
+ with:
+ remote-docker-image: "us-central1-docker.pkg.dev/topl-shared-project-dev/topl-artifacts-dev/faucet"

.github/workflows/release.yml

@@ -0,0 +1,32 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Release
+
+on:
+ push:
+ tags: ['*']
+
+jobs:
+ build:
+ uses: ./.github/workflows/_build.yml
+
+ publish_dockerhub:
+ uses: ./.github/workflows/_docker_publish_public.yml
+ needs: [build]
+ secrets: inherit
+ with:
+ remote-docker-image: "toplprotocol/faucet"
+
+ publish_ghcr:
+ uses: ./.github/workflows/_docker_publish_public.yml
+ needs: [build]
+ secrets: inherit
+ with:
+ remote-docker-image: "ghcr.io/topl/faucet"

Dockerfile

@@ -0,0 +1,27 @@
+# Stage 1: Build the Flutter app
+FROM ghcr.io/cirruslabs/flutter:3.10.6 AS build
+
+# Set the working directory to /app
+WORKDIR /app
+
+# Copy the entire Flutter project to the container
+COPY . .
+
+# Run the necessary Flutter commands to build the app
+RUN flutter pub get && \
+ flutter packages pub run build_runner build --delete-conflicting-outputs && \
+ flutter build web --release
+
+# Stage 2: Create a minimal image to run the built app
+FROM nginx:stable-alpine3.17
+
+USER nginx
+
+# Copy the built app from the previous stage to the nginx html directory
+COPY --from=build --chown=nginx:nginx /app/build/web /usr/share/nginx/html
+
+# Expose port 80 for the web server to listen on
+EXPOSE 80
+
+# Start Nginx
+CMD ["nginx", "-g", "daemon off;"]

Makefile

@@ -0,0 +1,111 @@
+all: lint format
+
+# Adding a help file: https://gist.github.com/prwhite/8168133#gistcomment-1313022
+help: ## This help dialog.
+ @IFS=$$'\n' ; \
+ help_lines=(`fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//'`); \
+ for help_line in $${help_lines[@]}; do \
+ IFS=$$'#' ; \
+ help_split=($$help_line) ; \
+ help_command=`echo $${help_split[0]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \
+ help_info=`echo $${help_split[2]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \
+ printf "%-30s %s\n" $$help_command $$help_info ; \
+ done
+
+build_web:
+ @flutter clean
+ @npm install
+ @npm run build
+ @flutter pub get
+ @flutter build web --web-renderer html --csp --release
+
+run_unit: ## Runs unit tests
+ @echo "╠ Running the tests"
+ @flutter test || (echo "Error while running tests"; exit 1)
+
+clean: ## Cleans the environment
+ @echo "╠ Cleaning the project..."
+ @rm -rf pubspec.lock
+ @flutter clean
+ @flutter pub get
+
+fix_warnings: ## fix any warnings
+ @echo "╠ Attempting to fix warnings..."
+ @dart fix --dry-run
+ @dart fix --apply
+watch: ## Watches the files for changes
+ @echo "╠ Watching the project..."
+ @flutter pub run build_runner watch --delete-conflicting-outputs
+
+
+gen: ## Generates the assets
+ @echo "╠ Generating the assets..."
+ @flutter pub get
+ @flutter packages pub run build_runner build --delete-conflicting-outputs
+
+format: ## Formats the code
+ @echo "╠ Formatting the code"
+ @dart format lib . -l 120
+ @flutter pub run import_sorter:main
+ @dart format . -l 120
+
+lint: ## Lints the code
+ @echo "╠ Verifying code..."
+ @dart analyze . || (echo "Error in project"; exit 1)
+
+upgrade: clean ## Upgrades dependencies
+ @echo "╠ Upgrading dependencies..."
+ @flutter pub upgrade
+
+commit: format lint run_unit
+ @echo "╠ Committing..."
+ git add .
+ git commit
+
+analyze:
+ flutter run dart_code_metrics:metrics analyze lib
+
+ditto:
+ echo "hello world"
+
+validate_packages:
+ @echo "╠ Validating packages..."
+ @flutter pub get
+ @flutter pub run dependency_validator
+
+arm_mac_hard_clean:
+ flutter clean && \
+ flutter pub get && \
+ cd ios && \
+ sudo rm -r Pods/ && \
+ rm -r .symlinks/ && \
+ rm Podfile.lock && \
+ sudo arch -x86_64 gem install ffi && \
+ arch -x86_64 pod install && \
+ cd ..
+
+file_test:
+ @reset
+ @flutter test test/middleware_test.dart
+
+nuclear_clean:
+ @echo "╠ Nuking pubcache completely, this might take a while...."
+ @flutter clean
+ @flutter pub cache repair
+ @flutter pub get
+
+test_coverage:
+ @flutter test --coverage
+ @genhtml coverage/lcov.info -o coverage/html
+ @open coverage/html/index.html
+
+web_profile:
+ @flutter run -d chrome --profile
+
+web_build_and_host:
+ @flutter build web --web-renderer html --csp --release
+ @cd build/web && python3 -m http.server 8000
+
+file_test:
+ @reset
+ @flutter test test/search/search_test.dart

android/app/src/main/AndroidManifest.xml

@@ -1,7 +1,11 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
+ <uses-permission android:name="android.permission.INTERNET" />
+ <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+ <uses-permission android:name="android.permission.WAKE_LOCK" />
  <application
  android:label="faucet"
  android:name="${applicationName}"
+ android:usesCleartextTraffic="true"
  android:icon="@mipmap/ic_launcher">
  <activity
  android:name=".MainActivity"