dcsil / dokada-app

Dokada's main code repo

Getting Started with Dokada

Setup

Debian based Linux systems (Ubuntu/Pop!_OS/etc.)

Run the bootstrap script provided in the root directory, the set up will be done automatically

Other Operating Systems

1. Install NodeJS and npm
2. Install a recent version of Python3 and pip3
3. run "pip3 install -r requirements.txt" in the root directory to install all dependencies
4. Install a MongoDB client that is compatible with your system

Run

Execute "npm install" and "npm run build" in root to build the frontend
Execute "flask run" in the root directory, the server will be hosted locally

Testing and CI

The testing are divided into backend and front end currently, they can both be run in the root directory
To run front end tests: npm test
To run back end tests: pytest

The CI is set up in github actions and contain tests for both part. Jest-test.yml tests the front end and api-functional-test.yml tests the backend

dokada-app's Issues

Some workflows have no defined timeouts or are not using ubuntu-latest

This repo has workflows that have no defined timeouts and/or are not using ubuntu-latest.

We use self hosted runners to avoid overage costs associated with GitHub Actions. However, we don't have a lot of workers to handle all of the load.
To ensure a single build doesn't spend hours and monopolize our workers, we limit each job to 20 minutes.
Please add a timeout to your jobs. We will disable your actions until you add them.

Your build may also be missing ubuntu-latest in the runs-on field.

Docs: https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes
Example:

jobs:
  build:
    runs-on: ubuntu-latest # This is required
    timeout-minutes: 20 # Add this line here

Affected Workflows:

Workflow Path	Job	Re-enable
.github/workflows/api-functional-test.yml	build	https://github.com/dcsil/Dokada-App/actions/workflows/api-functional-test.yml

Weight-based color interpolation and weight sorted layers

Change colors of the layers based on the selected weight for the single-view and aggregate view pages

Caching to speed up the aggregate paging stuff

Giving clients an option of adding more pictures

Work started on aggregate review page

Complete dashboard database integration

Disabling GitHub Actions

Congratulations on finishing the course!

To make sure we have have workers for the next term, we have automatically disabled your repository's actions.

Feel free to make this repo public or fork to your own org, but we do ask that you leave a copy in the DCSIL org :)

Consumer Front end

Show an interface for consumers to enter their reviews. This should be in accordance with our prototype.

Take into account the following points from user feedback:

1. Give an option for consumers to switch to color blind mode
2. Avoid complicated/confusing wording like "Decisiveness" and "Aggregate"
3. Use coloring as a highlighting method to provide feedback instead of separating into layers

Aggregation computations for newly added reviews

More complete unit testing

Aggregate review page done or close to done

After aggregating sufficient amount of data to build feedback prediction model

Disabling GitHub Actions

Congratulations on finishing the course!

To make sure we have have workers for the next term, we have automatically disabled your repository's actions.

Feel free to make this repo public or fork to your own org, but we do ask that you leave a copy in the DCSIL org :)

Tasks to be done before final submission

1. Port the layer weight slides in single view to aggregate view(Kerry)
2. Include front end tests in coverage(Kerry)
3. Increase coverage in both ends to 65%(Martin)
4. Make sure the final version app is deployed correctly(Kamran)

User login

More logging and monitoring

Image data bounding box

Create bounding box for the data in each layer to improve performance and expressibility for the interpretation algorithm

Basic pages for canvas tool and dashboard

Canvas data sending to database

Brainstorming on integrating computer vision/AI/ML for better performance

CI/CD set up

Setup CI/CD. Mostly likely will use Github actions.

Single review analysis complete with summary of data

Database setup. Load data

This repo is over usage of GitHub Actions minutes

This repo is over usage.

We have a limited number of GitHub Actions Runners. To ensure one team does not monopolize those workers we impose a monthly usage limit.
We impose a limit of 500 minutes per month.

You repo has currently used 505 minutes out of the allowed 500. This will reset at the end of the month.
At that time we will re-enable your CI job on GitHub.

In the meantime, make sure to run whatever that CI flow was doing manually, or push to a private repository in your own account

Testing

Client front end

The interface that we're planning to show to our business clients:

Take into consideration the following from user reviews:

1. Implement a grid in the aggregate view and make it semi transparent

Improve UI/UX based on collected feedback

Host basic site