Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greenpill-dev-guild/allo-yeeter
Repo holding code for client and contract for Allo Yeeter RFP making a simple tool to distribute funds built on top of Allo.
https://github.com/greenpill-dev-guild/allo-yeeter
allo allocation capital ethereum gitcoin optimism public-goods react solidity tailwindcss typescript vitejs
Last synced: 20 days ago
JSON representation
Repo holding code for client and contract for Allo Yeeter RFP making a simple tool to distribute funds built on top of Allo.
- Host: GitHub
- URL: https://github.com/greenpill-dev-guild/allo-yeeter
- Owner: greenpill-dev-guild
- Created: 2024-10-01T01:03:48.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T21:50:52.000Z (20 days ago)
- Last Synced: 2024-10-29T23:48:51.739Z (20 days ago)
- Topics: allo, allocation, capital, ethereum, gitcoin, optimism, public-goods, react, solidity, tailwindcss, typescript, vitejs
- Language: Solidity
- Homepage: https://allo-yeeter.vercel.app
- Size: 32.9 MB
- Stars: 8
- Watchers: 5
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# allo-yeeter
Repo holding code for client and contract for Allo Yeeter RFP making a simple tool to distribute funds built on top of Allo.
## Project Structure
This is a monorepo project managed with Turborepo and Bun as the package manager.
## Prerequisites
- Node.js (version 20 or later)
- Bun (version 1.1.20 or later)
## Getting Started
1. Clone the repository:
```
git clone https://github.com/greenpill-dev-guild/allo-yeeter.git
cd allo-yeeter
```
1. Set up submodules (allo-v2-sdk)
```
git submodule init && git submodule update
```
(later, use `git submodule update --remote` to download updates to SDK)
1. Install dependencies:
```
bun install
```
1. Build the kit package:
```
bun run build:kit
```
## Available Scripts
- `bun run dev`: Start the development server for all apps
- `bun run build`: Build all apps and packages
- `bun run lint`: Run linting for all apps and packages
- `bun run format`: Format all files using Prettier
- `bun run dev:yeeter`: Start the development server for the yeeter app
## Workspace Structure
This monorepo contains the following workspaces:
- `apps/*`: Application projects
- `packages/*`: Shared packages
## Development Workflow
1. Run `bun run build:kit` to build the shared kit package.
2. Use `bun run dev` to start development servers for all apps, or `bun run dev:yeeter` for the yeeter app specifically.
## Additional Information
- This project uses Turborepo for task running and caching. Check `turbo.json` for task configurations.
- The project is set up to use environment variables. Make sure to set up your `.env.*local` files as needed.
- For more detailed information about each app or package, refer to their respective README files in the workspace directories.
## Project Repository
You can find the project repository at: [https://github.com/greenpill-dev-guild/allo-yeeter](https://github.com/greenpill-dev-guild/allo-yeeter)