Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update with latest #167

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@

</div>

## Key Steps
- Set round timing variables in the .env. The application only works with one round at the time.
- Projects applications open
- Admins review applications and approve if relevant
- Voting opens by whitelisted addresses (by admins)
- Results are displayed
- Distribution can be done

<div style="display:flex">

[<img width="49%" src="./docs/images/screenshot_landing_project.png">](https://easyretropgf.xyz/sustainable-urban-development)
Expand Down
88 changes: 0 additions & 88 deletions docs/01_setup.md

This file was deleted.

23 changes: 18 additions & 5 deletions docs/02_adding_projects.md → docs/02_adding_applications.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Adding projects
# Anyone can create a project application for RAPGF

- Navigate to https://easy-retro-pgf-ochre.vercel.app/applications/new
![](./images/Create_application.png)


- Navigate to https://easy-retro-pgf.vercel.app/applications/new (replace the domain with your deployment)
- Fill out profile fields with name, profile image and banner image
- Fill out application fields
- **name** - the name to be displayed
Expand All @@ -12,20 +15,30 @@
- **impactMetrics** - links to your impact
- **fundingSources** - list your funding sources

![](./images/Application_create.png)

This will create an Attestation with the Metadata schema and populate the fields:

- `type: "application"`
- `roundId: NEXT_PUBLIC_ROUND_ID`

## Reviewing and approving applications
![](./images/Application_success.png)

## Admin review and approve applications

- Navigate to https://easy-retro-pgf.vercel.app/applications (replace the domain with your deployment)
- Navigate to https://easy-retro-pgf-ochre.vercel.app/applications
- Make sure you have configured `NEXT_PUBLIC_ADMIN_ADDRESSES` with the address you connect your wallet with
- You will see a list of submitted applications
![](./images/Review_page.png)

- Press the Review button to open the application
![](./images/Review_project_details.png)

- Select the applications you want to approve
- Press Approve button to create attestations for these projects (send transaction to confirm)
![](./images/Review_page_with_approved.png)

> It can take 10 minutes for the applications to be approved in the UI

[<img width="100%" src="https://cdn.loom.com/sessions/thumbnails/cfe9bb7ad0b44aaca4d26a446006386a-with-play.gif" width="50%">](https://www.loom.com/embed/cfe9bb7ad0b44aaca4d26a446006386a?sid=a3765630-b097-41bb-aa8b-7600b6901fe4)


5 changes: 3 additions & 2 deletions docs/03_creating_badgeholders.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Creating badgeholders

- Navigate to https://easy-retro-pgf.vercel.app/voters (replace the domain with your deployment)
- Navigate to https://easy-retro-pgf-ochre.vercel.app/voters (replace the domain with your deployment)
- Make sure you have configured `NEXT_PUBLIC_ADMIN_ADDRESSES` with the address you connect your wallet with
- Enter a list of addresses you want to allow to vote (comma-separated)
- Press Approve button to create attestations for these voters (send transaction to confirm)
![](./images/Approved_voters.png)

> It can take 10 minutes for the voters to be seen in the UI

[<img width="100%" src="https://cdn.loom.com/sessions/thumbnails/5ee5b309c2334370925a95615ed8bac5-with-play.gif" width="50%">](https://www.loom.com/embed/5ee5b309c2334370925a95615ed8bac5)

18 changes: 15 additions & 3 deletions docs/04_voting.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
# Voting

Once applications has been approved and the voters' addresses have been added, your voters can now vote for projects.
Once
- applications has been approved
- the voters' addresses have been added
- the voting window is open
your voters can now vote for projects
![](./images/Approved_projects_page.png)

- Navigate to https://easy-retro-pgf.vercel.app/projects
- Navigate to https://easy-retro-pgf-ochre.vercel.app/projects
- Click the plus icon on the project card or Add to ballot button in the project details page
- Click View ballot to navigate to the ballot page (https://easy-retro-pgf.vercel.app/ballot)
![](./images/Voting.png)

- Click View ballot to navigate to the ballot page (https://easy-retro-pgf-ochre.vercel.app/ballot)
![](./images/Review_ballot.png)

- Adjust the allocation
- Click Submit ballot and sign the message
![](./images/Voted.png)


You can also export your ballot as a CSV to import into Excel where you can make changes and later export as a CSV. This CSV file can then be imported and replace your ballot.

[<img width="100%" src="https://cdn.loom.com/sessions/thumbnails/ee5eff07fa3c47258bbdf42777087990-with-play.gif" width="50%">](https://www.loom.com/embed/ee5eff07fa3c47258bbdf42777087990?sid=34151556-5fd9-433f-bea3-aa4f81b2e597)

10 changes: 10 additions & 0 deletions docs/05_lists.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Lists

Lists can be created to help voters find projects to vote for. These lists include a name, description, impact evaluation, category, and a collection of projects with a recommended amount.

- Navigate to https://easy-retro-pgf-ochre.vercel.app/lists
- Fill out the list details
- Add projects. (currently search is case-sensitive and only matches beginning of project name)
- Click Create and sign the transaction

![](./images/Create_list.png)
6 changes: 4 additions & 2 deletions docs/06_results.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ Once the voting has ended you can view the results. There's a config determining

> ! Before the results can be displayed the vote calculation must be configured. See the [Distribute](./07_distribute.md) documentation.

- https://easy-retro-pgf.vercel.app/projects/results
> ! Before the results can be displayed the vote calculation must be configured. See the [Distribute](./07_distribute.md) documentation.

- https://easy-retro-pgf-ochre.vercel.app/projects/results

![](./images/voting_ended_sidebar.png)

You can also see statistics of the round:

- https://easy-retro-pgf.vercel.app/stats
https://easy-retro-pgf-ochre.vercel.app/stats

![](./images/stats.png)
4 changes: 1 addition & 3 deletions docs/07_distribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@

Once the voting has ended you can distribute tokens to the projects.

Navigate to:

- https://easy-retro-pgf.vercel.app/distribute
Navigate to: https://easy-retro-pgf-ochre.vercel.app/distribute

Before you should have configured your chosen payout token: `NEXT_PUBLIC_TOKEN_ADDRESS`

Expand Down
Binary file added docs/images/Application_create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Application_success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Approved_projects_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Approved_voters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Create_application.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Create_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Review_ballot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Review_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Review_page_with_approved.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Review_project_details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Voted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/Voting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 10 additions & 1 deletion src/components/Footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,16 @@ export function Footer() {
target="_blank"
className="group py-4 text-sm font-medium hover:text-black"
>
<div className="flex tracking-wide">Powered by EasyRetroPGF.xyz</div>

<div className="flex">
Built with{" "}
<span className="relative -mt-1 w-6 px-1 text-xl text-red-600">
<span className="absolute">❤️</span>
<span className="absolute group-hover:animate-ping">❤️</span>
</span>
&nbsp;on EasyRetroPGF.
</div>

</a>
</footer>
);
Expand Down
12 changes: 7 additions & 5 deletions src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@ import { getAddress } from "viem";
import * as allChains from "viem/chains";

export const metadata = {
title: "EasyRetroFunding",
description: "Open-source Retro Public Goods Funding platform",
url: "https://easyretropgf.xyz",
image: "/api/og",

title: "Obol RAPGF",
description: "Retro Public Goods Funding for the Obol Collective",
url: "https://easy-retro-pgf.vercel.app",
image: "https://i.ibb.co/VjHvtHN/Primary-Icon-Circle-Dark-BG.png",

};

export const config = {
logoUrl: "",
logoUrl: "https://i.ibb.co/VjHvtHN/Primary-Icon-Circle-Dark-BG.png",
pageSize: 3 * 4,
};

Expand Down
2 changes: 1 addition & 1 deletion src/layouts/BaseLayout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export const BaseLayout = ({
<Head>
<title>{title}</title>
<meta name="description" content={metadata.description} />
<link rel="icon" href="favicon.svg" />
<link rel="icon" href="https://i.ibb.co/VjHvtHN/Primary-Icon-Circle-Dark-BG.png" />
<meta property="og:url" content={metadata.url} />
<meta property="og:type" content="website" />
<meta property="og:title" content={title} />
Expand Down
33 changes: 33 additions & 0 deletions tailwind.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,39 @@ import { type Config } from "tailwindcss";
import colors from "tailwindcss/colors";
import theme from "tailwindcss/defaultTheme";


const customColors = {
primary: {
400: "#2FE4AB",
500: "#2FE4AB",
600: "#2FE4AB",
700: "#2FE4AB",
},
secondary: {
100: "#2FE4AB",
200: "#D7E6F9",
600: "#2FE4AB",
700: "#2FE4AB",
},
success: {
100: "#2FE4AB",
200: "#2FE4AB",
600: "#2FE4AB",
700: "#2FE4AB",
800: "#2FE4AB",
},
error: {
100: "#FDF6F2",
200: "#FAEAE0",
600: "#DD603C",
700: "#DD603C",
},
highlight: {
600: "#2FE4AB",
},
};


export default {
content: ["./src/**/*.tsx"],
darkMode: "class",
Expand Down