New Tool: Events indexing service - Milestone 4

prpatel05 commented 3 years ago

New Tool: Events indexing service - Milestone 4

Description

This PR is for issue #15.

Prepare the final version of the application as a deployable artifact (e.g. Docker image), along with a basic example consumer application and accompanying documentation.

Submission Links & Documents

Code Package: https://github.com/prpatel05/FlowRider (reach out if you need access). Documentation Site: https://www.flowrider.io/ (Backup: https://main.do301prso5m29.amplifyapp.com).

> The following pieces of documentation need to be completed alongside the code for a successful submission: >> Installation Guide: How to get this application up and running. >> Usage Guide: A highlight of all the features available and how to use them. Guides - This site should walk through, setting up CLI, configuring, and running it. Additionally, it has some demo/videos on example uses. >> Contribution Guide: A thorough explanation of the codebase, where features are located, a diagram explaining complex interactions, etc. This is intended to be a primer for new contributors that would like to add or modify features. Guide

Requirements Check

Have have you met the milestone requirements? - Yes
Have you included tests (if applicable)? - Yes
Have you met the contribution guidelines of the repos you have submitted code to (if applicable)? - Yes
If this is the last milestone: - Yes
- Demonstrate that you've met all the acceptance criteria (link to code, demos, instructions to run etc.) - Yes
- Demonstrate that you've met all milestone requirements and highlight any extensions or additional work done. - Yes
- Include a payout structure by percentage for each team member (ie. Bob: 20%, Alice: 80%). Pratik: 100%

Other Details

Is there anything specific you'd like the PoC to know or review for? - Reach out if you need access - (Discord) prpatel05#3792
Are there other references, documentation, or relevant artificats to mention for this PR (ie. external links to justify design decisions, etc.)? - https://elfin-diamond-a02.notion.site/Events-Indexing-Service-Design-8a4adb6cf53745ab942bd12248f3b38b

nvdtf commented 3 years ago

FlowRider seems awesome and exciting! Thanks for taking the effort and time to put this together. My initial feedback on the project:

Can we add more information to the root README file? Because there is a dedicated documentation website, the README can contain a general overview of what features are provided and what can be done in the project. Developers wouldn't have to dive into docs to know whats implemented here.
This might be a stretch but having a containerized output, ideally through a Makefile command like make containerize can help a lot of developers. It's also ideal if we can have a sample project that spins up a containerized FlowRider alongside a containerized flow emulator and containerized database (like postgres) to showcase how all the pieces can work together on the cloud.
Having AWS sample deployment files for the above can be beneficial, but I consider it a "nice-to-have". Maybe if there was work done earlier on this we can deliver it as sample deployment yaml files for AWS.

prpatel05 commented 3 years ago

> FlowRider seems awesome and exciting! Thanks for taking the effort and time to put this together. Thank you!

Good feedback, we can definitely do the first one before the 7th. I will investigate what it would take for the other two.

prpatel05 commented 3 years ago

Okay the README is updated here with an overview, documentation website link, and feature set. Let me know if this is what you had in mind or if you are looking for additional information there.

Additionally, I setup the logic to get this as a docker containerized image and the ability to run via Docker vs. the CLI. You can find the instructions on the site under "Deploying". Currently it is done via manually building the image from the package. However, similar to the CLI being available via NPM, this will be available via a public Docker repo so that the user can just quickly run it via a command like - docker run flow-rider/flow-rider:1.0.0, without needing access to/build the repo.

I don't yet have the sample project, I don't believe I will have the time to get this done before the 7th. Let me know if you believe this would be a blocker for sign-off?

nvdtf commented 3 years ago

Thank you for actioning the feedback items. I think it satisfies what I had in mind, maybe the AWS sample deployments can be left out for later if there's nothing to reuse from earlier phases.

Great job!

kerrywei commented 3 years ago

merge in the PR per Navid's approval

onflow / flip-fest