Skip to content

Latest commit

 

History

History
48 lines (26 loc) · 2.54 KB

README.md

File metadata and controls

48 lines (26 loc) · 2.54 KB

Welcome to the egghead-next project—the front-end for egghead.io.

Development

If you've already set up your local development environment, you can run:

pnpm dev

Setting Up Your Development Environment

To run this app locally for development, you'll need a few things. One of those is a working installation of egghead-rails which provides the back-end functionality.

1. System-level stuff.

For the basic stuff like Homebrew, Node, pnpm, etc., run bin/validate to ensure you have the base requirements. It will help you install anything that's missing.

2. Vercel & Develoment Environment Variables

Before you run the following commands to connect the development environment to Vercel

vercel login will prompt you to login and verify vercel link will ask you to choose the eggheadio organization and the egghead-io-nextjs project. vercel env pull will bring in the development environment variables you need to get going.

3. egghead-rails

You'll need to walk through the egghead-rails setup instructions. Once it's running, you should be able to start it by running the following from the project root:

foreman start -f Procfile.dev

If you want to test something that requires Stripe webhooks to be connected, you'll need to use the stripe listen command. Review docs/stripe/webhook.md for the details.

Important: For the Stripe webhook process to work, you'll want to ensure that the following values are updated to the correct latest values:

  • STRIPE_WEBHOOK_SECRET will be provided by the stripe listen command in egghead-rails that will display a 90-day secret that it auto-generates for connecting webhooks.
  • NEXT_PUBLIC_STRIPE_PUBLIC_KEY & STRIPE_SECRET_KEY can be found on the Stripe Development API Keys page

You'll also need to ensure that the webhook_signing_secret is updated in the egghead-rails config/credentials.yml.enc. For instructions on that, view the config/credentials/editing_credentials.md file in egghead-rails.

4. Start Developing

To run egghead-next once egghead-rails is running, use:

pnpm install && pnpm dev

5. Handy Commands

View the scripts section of package.json for the primary development commands to run with pnpm.