Skip to content

Latest commit

 

History

History
146 lines (117 loc) · 6.28 KB

README.md

File metadata and controls

146 lines (117 loc) · 6.28 KB
Raw

Confily

Real life Kotlin Multiplatform project with an iOS application developed in Swift with SwiftUI, an Android application developed in Kotlin with Jetpack Compose and a backed in Kotlin hosted on AppEngine.

Backend Features

Mobile Features

  • Select your conference
  • Conference schedule
  • Bookmarking of talks
  • Speaker page with biography, socials and talks
  • Networking space which privacy respect from mobile to mobile
  • Partners with description, socials, jobs and location
  • Event page with socials, location, menus, q&a and code of conduct
  • Scan your event ticket
  • Android wearable companion app
  • Enjoy your conference!

Build With

  • Kotlin - First class and official programming language for Android development
  • Jetpack Compose - Modern toolkit for building native UI
  • Compose Multiplatform - Multiplatform approach based on Jetpack Compose
  • Accompanist - Collection of extension libraries for Jetpack Compose
  • Coil - Media management and image loading framework for Android
  • ViewModel - Stores UI-related data that isn't destroyed on UI changes
  • Navigation Compose - Allow users to navigate across, into, and back out from the different pieces of content within your app
  • Swift - First class and official programming language for iOS development
  • SwiftUI - Build apps across all Apple platforms with Swift
  • Koin - Pragmatic Kotlin & Kotlin Multiplatform Dependency Injection framework
  • Kotlin Coroutines - Light-weight threads
  • kotlinx.serialization - Kotlin Multiplatform / multi format serialization
  • SQLDelight - Generates typesafe Kotlin APIs from SQL
  • Okio - A modern I/O library for Android, Java, and Kotlin Multiplatform
  • Multiplatform Settings - Kotlin Multiplatform library for saving simple key-value data
  • ktor - Client to make HTTP request and HTTP server routing
  • Firestore - JVM client to make request on Firestore
  • Storage - JVM client to make request on Storage
  • Drive - JVM client to handle documents in a Google Drive

Testing

Running in local

Start firebase emulators inside a terminal with Firestore service.

firebase login # If you are not yet logged
firebase emulators:start --project $RANDOM_FIREBASE_PROJECT_ID

Start appengine server inside another terminal to interact with the local instance of your Firebase.

export GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json
export PROJECT_ID=$RANDOM_FIREBASE_PROJECT_ID
export BASE_URL_CONFERENCE_HALL=conference-hall.io
./gradlew :backend:installDist && ./backend/build/install/backend/bin/backend

Now, you can start to interact with the backend.

Deploy in GCP

Prerequisites

  • Gcloud app created: gcloud app create
  • Billing account enabled on your GCP project
  • Cloud Build service enabled
  • Cloud Firestore service enabled
  • Secret Manager enabled
  • Geocoding enabled
  • Add secret GEOCODE_API_KEY in Secret Manager with geocoding api key
  • Grant your GCP service account with these permissions:
    • Cloud Run Invoker
    • Secret Manager Secret Accessor
    • Storage Object Creator
    • Storage Object Viewer

Deploy in GCP with AppEngine

Be sure to edit the app.yaml file in backend/src/main/appengine folder with your project id before to deploy.

export PROJECT_ID=<your-project-id>
# If you are not yet logged
gcloud auth login
gcloud config set project $PROJECT_ID
# Deploy
./gradlew :backend:appengineDeploy

Deploy in GCP with Cloud Run

export PROJECT_ID=<your-project-id>
# If you are not yet logged
gcloud auth login
gcloud config set project $PROJECT_ID
# Deploy
gcloud run deploy confily \
  --source . \
  --platform managed \
  --port 8080 \
  --region europe-west1 \
  --set-env-vars=PROJECT_ID=$PROJECT_ID \
  --allow-unauthenticated

References

License

Copyright 2022 Gérard Paligot.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.