https://github.com/kevmoo/knarly_vote

Dart, Flutter, Google Cloud, and ranked voting!
https://github.com/kevmoo/knarly_vote

dart flutter

Last synced: about 2 months ago
JSON representation

Dart, Flutter, Google Cloud, and ranked voting!

• Host: GitHub
• URL: https://github.com/kevmoo/knarly_vote
• Owner: kevmoo
• Created: 2021-07-19T20:12:13.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-20T02:23:47.000Z (over 1 year ago)
• Last Synced: 2024-12-25T20:02:43.664Z (about 2 months ago)
• Topics: dart, flutter
• Language: Dart
• Homepage: https://knarlyvote.com
• Size: 251 KB
• Stars: 32
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Dart CI](https://github.com/kevmoo/knarly_vote/actions/workflows/dart.yml/badge.svg)](https://github.com/kevmoo/knarly_vote/actions/workflows/dart.yml)

Try it out: https://knarlyvote.com

# tl;dr

A (work-in-progress) demonstration of: (1) a full-stack

[Flutter](https://flutter.dev/) application utilizing

[Firebase](https://firebase.google.com/) and

[Google Cloud](https://cloud.google.com/), and (2) ranked voting with the

[Condorcet Method](https://en.wikipedia.org/wiki/Condorcet_method).

# Components

![Data flow](docs/data_flow.png)

# Event flow

![Event flow](docs/event_flow.svg)

# YouTube discussion about the project

[![Rubber Duck Engineering #58](https://img.youtube.com/vi/SImcty5QJhM/maxresdefault.jpg)](https://www.youtube.com/watch?v=SImcty5QJhM "Video Title")

From July 29, 2021

# Getting started and local development

1. Copy `server/server_config.example.yaml` to `server/server_config.yaml` and

   populate the entries. See the details in `server/lib/src/service_config.dart`

   for the expected values.

   _TODO_ explain the values needed to run locally vs to deploy.

1. Make sure you have [package:shelf_dev](https://pub.dev/packages/shelf_dev) v2

   or later installed.

1. Run `shelf_dev` from the root of the repository to start the app. It will be

   hosted at `localhost:8080`.

# Deployment

_todo_ Sketching things out here, but this is incomplete at the moment.

1. Deploy services

   1. Enable cloud tasks and create a task queue.

   1. Enable cloud run.

      1. Make sure the name of the service corresponds to the value in

         `hosting/rewrites` in `firebase.json`.

   1. Set variables using `server/tool/update_cloud_run_environment.dart`.

   1. Deploy cloud run service

2. Web app

   1. Build and deploy web app. `firebase deploy`.