README.md

Grove Portal UI

Table of Contents

• Run with Remix
• Deployment
• Development
  • Env
  • Node Version
  • Frontend
  • Stripe Webhook Forwarding
  • Environment Variables
  • Backend

Run with Remix

• Remix Docs

Deployment

1. Test Locally

   • Test your changes locally before creating a PR.

2. Test in Staging

   • Create a PR into the "staging" branch.
   • Continuous Deployment (CD) will automatically deploy to https://staging.portal.grove.city.
   • eg. #660

3. Deploy to PROD

   • Create a PR from "staging" into "main".
   • CD will automatically deploy to https://portal.grove.city/.
   • eg. #662

4. Test in Main

   • Test your changes in the main environment to ensure everything is working as expected.

Development

Env

Make sure to get the .env from 1password.

Node Version

---

Ensure you're using Node v18 (not 22).

Frontend

To run your Remix app locally, make sure your project's local dependencies are installed:

pnpm install

pnpm build

Afterwards, start the Remix development server like so:

pnpm dev

Open up http://localhost:3000 and you should be ready to go!

If you're used to using the vercel dev command provided by Vercel CLI instead, you can also use that, but it's not needed.

Stripe Webhook Forwarding

If you wish to test the Stripe webhook flow, you must use the Stripe CLI to forward the webhook to your local environment.

Full instructions can be found on the Stripe documentation page.

You must initialize the Stripe CLI with your Stripe account:

stripe login

Then run the following to start forwarding webhooks:

stripe --api-key {STRIPE_API_KEY} listen --forward-to http://localhost:3000/api/stripe/webhook

It is generally recommended to use the test mode Stripe API key for forwarding webhooks, as this will not create any real subscriptions or charge any real money.

You will be given a webhook signing secret, set it in your .env file as STRIPE_WEBHOOK_SECRET.

The webhook handling code in this repo can be found here..

Environment Variables

You can find the environment variables - including for Stripe- here.

Backend

This currently requires you to also run the current portal backend on localhost:4200 in order to run. I am working with the backend team to whitelist localhost and enable us to hit the backend.staging.portal.pokt.network endpoints.