This package serves the app which holds all the features w.r.t to
- creating a program
- maintaining a program
- creating a round
- maintaining a round
This package is meant to be used by the round operators It relies on the contracts deployed from the contracts package. Indexed data can be queried by the graphs deployed from Allo's graph repository.
| Env | Git Branch | URL |
|---|---|---|
| STAGING | main | https://rmgitcoin.on.fleek.co/ |
| LIVE | release | https://round-manager.gitcoin.co/ |
.
├── public # Public Assets
├── src
│ ├── app # Stores/Hooks
│ ├── features
│ ├── auth # components/services related to authentication/authorization
│ ├── program # Program related components/services
│ ├── round # Round related components/services
│ ├── api.ts # Empty API service (feature APIs will inject endpoints)
│ ├── browserPatches.tsx # Browser polyfill
│ ├── index.tsx # Routes
│ ├── index.css # Global CSS
├── tsconfig.json # Typescript configuration
├── craco.json # Craco configuration
├── package.json # Package configuration
└── README.md
The app structure ensures all components and services related to a particular feature are kept in a subdirectory of the features directory.
Observe the directory structure for Authentication feature in features/auth
├── features
│ ├── auth
│ │ ├── ProtectedRoute.tsx
│ │ ├── web3Service.tsx
It contains the ProtectedRoute component and web3Service which extends the base API service defined in src/api.ts by endpoint injection.
Since all the data is decentralized stored, there might be PII (Personally identifiable information) data which we cannot store. To see how we handle those scenarios, checkout EncryptingPII.md
To contribute to this project, fork the project and follow the instructions at DEV.md
To set up monitoring for this project, follow the instructions at MONITORING.md