Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 5.28 KB

README.md

File metadata and controls

108 lines (73 loc) · 5.28 KB
Raw

Stampy UI

Stampy!

Stampy UI is an interface for aisafety.info, a questions and answers site about AGI safety, built with Remix and Cloudflare Workers. When reading about existential risks becomes "too serious", we also have a more playful version of the site: stampy.ai.

Contributions are welcome, the code is released under the MIT License. If you'd like to join the dev team, drop by our Discord and post in #stampy-dev!

Stampy UI Development Setup

  1. Requirements

  2. Clone the Repo

    • Run git clone https://github.com/StampyAI/stampy-ui.git

  3. Setup in Cloudflare Dashboard

    • If you haven't already, set up your free custom Cloudflare Workers subdomain
    • From the left menu Workers : Overview, note your Cloudflare Account ID on the right
    • From the left menu Workers : KV, create a KV (key-value store) namespace STAMPY_KV
    • Note the new created STAMPY_KV Namespace ID
    • Copy wrangler.toml.template to wrangler.toml
    • Replace the values for your {CLOUDFLARE_ACCT_ID} and {STAMPY_KV_ID} in wrangler.toml

  4. Setup in Coda.io

    • 4.1 (Required) Setup read access to the API view in Coda

      Note: Content in Coda comes from parsing Google Docs (so that site visitors can make suggestions that will be reviewed by our editors). The parser lives in the GDocsRelatedThings repo.

    • When logged in to Coda, Generate API token in your Account settigns

    • Add restrictions: Doc or table, Read only, for the doc with url https://coda.io/d/_dfau7sl2hmG (you need access to the doc of course, which you can request on the Discord)

    • Replace the value for {CODA_TOKEN} in wrangler.toml

    • 4.2 (Optional) Setup write access to the API write view in Coda

      Note: This step is only needed for incrementing counters (helpful, etc.). There isn't a test environment, so any changes there will also effect the live site, so think twice before using them.

      • When logged in to Coda, Generate API token in your Account settings
      • Add restrictions: Doc or table, Read and Write, for the table with url https://coda.io/d/_dfau7sl2hmG#_tutable-eEhx2YPsBE
      • Replace the value for {CODA_WRITES_TOKEN} in wrangler.toml

    • 4.3 (Optional) Setup write access to the "Incoming questions" table in Coda

      Note: This step is only needed if you want to add new questions to Coda, or you want to mark answers as helpful. Seeing as they will then go live, it would probably be better to only set this if you are working on those specific component, in order to not mess up the list of incoming questions.

      • When logged in to Coda, Generate API token in your Account settigns
      • Add restrictions: Doc or table, Read and Write, for the table with url https://coda.io/d/_dfau7sl2hmG
      • Replace the value for {CODA_WRITE_TOKEN} in wrangler.toml

  5. Create stampy-ui Remix environment

    • Change directory to where you downloaded the stampy-ui github repository: cd stampy-ui
    • Run npm install to install all the dependencies required to run the current version of stampy-ui.

Once that's done, you should be able to test and deploy your app!

Local Development

$ npm run dev

Lint and Tests

$ npm run lint
$ npm run test

Tests may rely on cached data from coda. This data can be refreshed by running:

$ npm run refresh-test-data

Deployment to your CF Worker

$ npm run deploy

Production domains are deployed via GitHub Actions.

Add a new domain

If the same CF worker should be reachable from another domain:

  • log in to Cloudflare Dashboard owned by @plexish
  • use Add a site button on homepage, choose the Free plan
    • in the DNS section for this site > Add record for 2 new CNAME records:
    • CNAME @ stampy-ui.stampy.workers.dev
    • CNAME * stampy-ui.stampy.workers.dev
  • go to Workers > stampy-ui > Triggers
    • in Routes section > Add route with the new domain (e.g. example.com/* and select the zone to the just-added site)
  • update your domain registrar to enable CF
  • check the site after a few minutes (CF claims "up to 24 hours", it's usually faster ... but don't share the link too widely on the first day)