davidgasquez / gitcoin-grants-data-portal

🌲 Open source, serverless, and local-first data hub for Gitcoin Grants data!
https://grantsdataportal.xyz/
MIT License
27 stars 3 forks source link

Document how to run `publish & deploy` from fork #59

Open DistributedDoge opened 8 months ago

DistributedDoge commented 8 months ago

Instructions given in readme are sufficient to play with data portal in interactive manner:

  1. Clone on local machine OR enter codespace, install dependencies
  2. make dev to spin-up dagster.
  3. Enter dagster instance, run whichever models you want.

BUT, what steps are needed to run publish & deploy Github Actions workflow from a fork?

Here is the summary of steps I had to take, may be slightly outdated:

  1. Register filebase account
  2. Create filebase key and add it to repository- wide ${{ secrets.FILEBASE_KEY }} + ${{ secrets.FILEBASE_SECRET }}
  3. Create filebase bucket with new name ( gitcoin-grants-data-portal won't work = bucket names have to be unique site-wide)
  4. Change filebaseBucket: gitcoin-grants-data-portal inside /.github/workflows/run.yml to new bucket name

This is for bucket, now we may also need to:

  1. Setup github pages.
  2. Register Covalent Account + add key to repository secrets

Once I have a moment I would put those steps in small HOW TO document on the off-chance that there is a single person somehow interested in running 100% independent replica of a portal (I found it handy for development to test CI changes + preview how portal-site would look like).