potlock / bos-app Goto Github PK
View Code? Open in Web Editor NEWPotLock BOS (blockchain operating system - decentralized front ends) App
License: MIT License
PotLock BOS (blockchain operating system - decentralized front ends) App
License: MIT License
https://ascii-tree-generator.com/
A BOS Developer needs clear heiracrchy to udnerstand how to structure BOS components.
As a developer, I want to have a clear folder heigharchy, so that I can easily setup my BOS workspace and understand how components will be mapped
Extension of sitemap but more composable components
bos-app/
├─ type/
├─ widget/
│ ├─ attestation/
│ │ ├─ index.jsx
│ ├─ chefDasboard/
│ │ ├─ createRound/
│ │ │ ├─ index.jsx
│ │ ├─ managePot/
│ │ │ ├─ approvedApplicants.jsx
│ │ │ ├─ applicants.jsx
│ │ │ ├─ rejectedApplicants.jsx
│ │ ├─ index.jsx
│ ├─ donor/
│ │ ├─ index.jsx
│ ├─ explore/
│ │ ├─ featuredProjects.jsx
│ │ ├─ explorePots.jsx
│ │ ├─ index.jsx
│ ├─ home/
│ │ ├─ index.jsx
│ ├─ navbar/
│ │ ├─ index.jsx
│ ├─ pot/
│ │ ├─ index.jsx
│ │ ├─ projectPotProfile.jsx
│ ├─ pots/
│ │ ├─ featuredPots.jsx
│ │ ├─ index.jsx
│ │ ├─ activePots.jsx
│ │ ├─ searchPots.jsx
│ ├─ project/
│ │ ├─ index.jsx
│ ├─ search/
│ │ ├─ index.jsx
│ ├─ transaction/
│ │ ├─ index.jsx
│ ├─ landing/
│ │ ├─ index.jsx
│ │ ├─ hero.jsx
│ │ ├─ buitWith.jsx
│ │ ├─ stats.jsx
│ ├─ footer/
│ │ ├─ index.jsx
│ ├─ index.jsonc
├─ bos.config.json
├─ README.md
show all transaction affiliated with PotLock including (funding factory, pots, donations, registry)
Explain the problem in details
As a _______, I want to ____, so that I can
Description of solution
Outline what needs to be done
Outline any potential limitations
https://near.org/near/widget/ComponentDetailsPage?src=frol.near/widget/TransferNEAR&tab=source (Reference Contract no fee)
Test transfer transaction: https://explorer.near.org/beta/transactions/7fRzkGH5dtDjWb5jLu5ZECzzKSciAtzdLAbiTsKL1F7y
Calculating quadratic funding will be too gas intensive and dependent on RPC
As a chef, I want to view matched contributions and funding pool amount when matching round closes and calculate payouts amounts, then call the contract, so that I can calculate payouts without wasting on chain resources.
Create BOS component to do quadratic calculation and calls contract
On the contract
Need to run logic in component https://github.com/gitcoinco/quadratic-funding/blob/master/quadratic-funding/clr.py
Chefs need a way to apply for role and ReFI council need an open inbound for chefs in the same place where they can propsoe to add them.
As a ReFI council member, I want to a dashboard of Chefs, so that I can easily keep track of applicant flow
Chef Application page where they do BOS post and has feed to propose to add members of dao.
Compose
Currently there is no view for admins to flag or block projects in the project registry (projects are on the whitelist bby default). thies means although their is fee associated if we subsdizie this then they could spam our registry.
As a ReFi Council or Admin, I want to be able to have a dashboard for changing project status, so that I can prevent for spam from showing on PotLock
As a ReFi Council or admin, I want to be able to see a unfilter project registry, so i can change the status
A simple dashboard that shows projects in project registry and proposes to change status.
For admins
A chef needs to see new milestones that come in from projects to effectively review, or their will be funding locked in Pot round.
As a chef, I want to be able to see new milestones submitted, so that I can properly review if they meet the acceptance criterion on time.
In the Chef dashboard their should be a milestones section that shows newly submitted milestones.
Ability to filter by incomplete milestones and recents
If someone contributes to matching round than they are a Patron. Show funding rounds affilaited with patron and percent of funding round a patron has put.
This will also be linked to when rounds show donors , patrons are logged in the navbar this is profile page link for patrons
Projects, users, and patrons themselves would like to see impact of individual patrons and history of contributing to matched rounds.
As a _______, I want to ____, so that I can
Description of solution
Outline what needs to be done
Nice to have
Outside of project sign up, projects need a way to apply for a pot directly.
Create an easy application page that is navigable from a pot page for proejcts to apply. Also keep in mind that there will be popup for eligibility requirements and indicators for projects to sign up if not already part of proejct registry.
Contract
Users need to see social validations through on chain analytics if they want to donate
An analytics section on homepage clearly showing impact through number of proejcts & amount of funding
Round managers need to query dashboards to see rounds they are admins for
As a _______, I want to ____, so that I can
Description of solution
Outline what needs to be done
Outline any potential limitations
Figure out how registry.potlock.io works in tangent with NEAR Horizon and Social DB sign up (be clear about what information for each)
Create a project onboarding form on BOS where data leverage nearhorizon.near, registry.potlock.near, Important we get this set up because we can have our community people start to register now
Explain the problem in details
As a _______, I want to ____, so that I can
Description of solution
Outline what needs to be done
Parts of this page
Outline any potential limitations
Need to be able to attest to a project so chefs can give sbts based on attestation.
As a verfieid human, I want to attset for a project from project page, so that I can easily leave an attestation
Form to create attestations for verified humans for a proejct.
Outside of a gateway, their needs to be a navbar (that can be toggled based on whther displayed on gateway) to navigate across different apps
As a users, I want to have a global navbar, so that I can easily navigate through compoennts
A BOS based global navbar
People have a hard time navigating through app with such a complex sitemap
-As an observer, I want to see the Gtihub and Socials of PotLock, so I can use the website and do due diligence.
A universal footer so people don't get lost and have better navigation ot all major call to actions and social
Users need to be able to see a project, outside of a round. Associated rounds, and all information about a project regarding potlock.
Create an all encompassing project profile pages that shows rounds, project profile from potlock, socialDB, and nearhorizon.near, attestations.
General
Related Projects
Need to see all the chefs in one place
As a ReFi council member, I want to see all Chefs profile, so that I can easily audit all the chefs.
Page card of all chefs (could be in search)
outline links and relevant resources, references implementations
Need a way to setup a BOS workspace for all components to rapidly upload multiple components, switch network and switch development account names.
As a a developer, I want to be able to have a dev einvronment in VS code, so that I can easily switch between dev environemnts and staging accounts as well as onboard other developers.
Setup BOS workspace on vs code
Add components based on nested components in https://github.com/PotLock/bos-app
As an observer, I want to see the Gtihub and Socials of PotLock, so I can use the website and do due diligence.
Explain the problem in details
As a _______, I want to ____, so that I can
Description of solution
Outline what needs to be done
Outline any potential limitations
Currently there is no way to share an individual attestation.
As a project founder, I want to be able to share and access an individual attestation, so that I can easily share testimonials.
An attestation page that takes an attestation id.
Attestation page
Pot managers / Chefs need to review milestones in timely fashion so that projects shipping can be funded quickly
As a chef, I want to see new milestones and past rejected milestones, so that I can be dilligent about projects getting funded in pots with milestones.
Milestone dashboard where Chef can's directly review milestones.
Create a way for users to add to a cart so donations, and matched donations will be streamlined, persistent, so someone can edit later once they are prepared to make a transaction
General
Round Page
Cart
matched round
Pass in props, funding roundID (pulls in number of contributors, amount of each contribution, total amount in matching pool, and estimates how much any amount of donation would be matched by.
Project applications are often confused with projects themselves but need to be their own page to show associated status, but are actually associated with funding round.
This is different than actually applying to a round. This is after the form has been submitted for audting purposes and for toher people to see applications.
Nice to have
Create a landing page on BOS to transition from traditional potlock.io website
As a user, I want to have a landing page, so that I can navigate to the rest of the app
Landing page on BOS
SHould have
This component would live inside a Chef page.
In other funding applications often we cant do dilligence on a Chef, who there may be evidence of kickbacks when it comes to applications, and milestones.
As a observor, I want to see a page for a chef, so that I can do dilligence.
As a council member, I want to be able to award SBTs or revoke a role, based on performance of a chef, so I can have a check and balance on Chef
Page for round manager
If Council member
As an admin, I should be able to manage/edit a Pot's config once it is deployed.
Need a way to navigate all projects in one single page
As a observor, I want to see all the projects on PotLock, so that I can, potentially donate directly to a proejct.
Create a project profile directory based on potlock registry that lets users explorer all projects.
Projects need a clear way to submit milestone evidence
As a project, I want to ____, so that I can
component for submitting evidence for a milestone
Outline what needs to be done
Outline any potential limitations
Projects need a dashboard to manage interactions with potlock ecosystem
Project dashboard so project owners can login to their project account and see the status of rounds, contributionsl, and any relevant milestones for round
After someone follows a potock project (a project in the registry) they would like to see updates from them in a feed. Also obserovors would like to see what all whitelisted projects are doing.
Create a feed page of all Potlock projects and ones a user is fllower
Currently those going to my profile are bounty to particular profile stakeholder pages, but a person maybe a series of different stakeholders
Create a profile page that shows holistic view of a user that can be navigated via my profile.
General Profile
Instead of paying directly donation buy donation, donors and verified humans should be able to put all their items in a cart, remove and edit this cart, and payout at once.
Create a cart view where users can see both simple donations and quadratic matched donations for active rounts.
View
Users need a way to discover over pots
As a supporter, I want to see related pots , so that I can continue to donate or compare a pot against smiliar past pots
A component that takes in a pot and shows a row of related pots that link to their pages
As a donor, their needs to be a place where you can see donor information
BOS Profile page that shows donor related information
Need a way to navigate all funding roudns to see upcoming, active, and future rounds.
A pots page, that lets user navigate past all rounds and filter accordingly
Explain the problem in details
As a _______, I want to ____, so that I can
Description of solution
Outline what needs to be done
Outline any potential limitations
Need detailed page about funding round so their is transparency regarding applications, and call to actions for chefs, donors, patrons.
Chef
As a chef, I want the public to see information about a round like round name, description, eligibility requirements like soul bound tokens, so that people know what a round is about.
As a chef, I want people to see financial information about a round like external contribution, the matching pool, and how much Chef and protocol makes in fees and what the rates are (with a tooltip on calculations, so their is transparency regarding financial information.
As a chef I want their to show the status of the round, whether it is upcoming
As a chef, I want donors to know they can donate and show a button for this with a referral link for fundraisers, up until the round closes, so that the matching pool can continue to increase.
AS a chef, I want the biggest patron logos to automatically show (pull from profile information) so that their is social validation that this round is supported, and i dont have to enter this information automatically.
As a chef, from the round page, I want there to be a manage button that shows so I can easily access the Chef dashboard.
As a chef, I want the page to specify currency of round so patrons and donors know what they need in their wallet.
As a chef, I want the round page to show accepted and reject applications (and that I made this decision) with reasoning, so that my decisions are transparent to community
As a user, I want to navigate to a pot page, so that I can see all associated criterion with a pot.
As an observor, I want to see analytics for donor for funding rounds (who donate the most, which set of projects they donated to, and estimated matching in real time), so I can see power users for the PotLock platform.
As a project founder, I want to be able to see an apply button prominent on the round (“pot”) so that I can easily apply to active rounds
As a project founder, I want to see on the round profile whether I have beenf reject or applied
As a project founder, when the round (“pot”) is active and I am in the round, i want to see how much contributions and donations came directly to my project.
Create a pot page to users can navigate to a share funding rounds
Applicants
Outline any potential limitations
Add notifications for
Here is iOS application and Android for BOS Notifications
📱 Download now for Android: Google Play Store
🍏 Get it on iOS: App Store
Explain the problem in details
As a _______, I want to ____, so that I can
Description of solution
Outline what needs to be done
Outline any potential limitations
Right now when projects register their is no way for projects to directly support another project.
Create a donation button with an amount on each page.
-adding add to cart later
After a milestone is submitted there needs to be a page to display milestones submitted in details to expand on and to link to
As a project, I want to see milestone evidence that has been submitted, so that I can keep track of my progress and see the view round managers will be taken.
Create a page that shows milestones
Milestone evidence shows everything in milestone form
Status
Need a styled component library so people can easily fork and we can rapidly development components
As a developer, I want to create PotLock styled components, so that I can rapidy prototype
A set of buttons, styled componened kits to rapidly prototype bos components without repeating code
Outline what needs to be done
Chefs need to be able to have a place where they can see applicants so there isn't a backlog.
Also, they need to calculate and set payouts once their Pot has completed.
As a chef, I want to see all applications, so that I can easily filter through backlogs
An applications status portal in a chef dashboard.
Adminneed to a graphical user interface for creating a post
As a council members, I want to be able to create a pot, so that they can set parametrs for chef.
Form to create a pot and setup custom parameters. Interacts with PotFactory contract.
Add a create pot page
Explain the problem in details
As a _______, I want to ____, so that I can
Description of solution
Outline what needs to be done
Outline any potential limitations
Explain the problem in details
As a _______, I want to ____, so that I can
Description of solution
Outline what needs to be done
Outline any potential limitations
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.