isabella232 / explorers

🚀👩‍🚀👨‍🚀
Jamstack Explorers

Presented by Netlify

Ground Control to Major Tom
Ground Control to Major Tom
Check your Lighthouse scores and put your <Helmet /> on
Ground Control to Major Tom
Commencing countdown, dark mode on
Check your build logs and why didn’t you use Vue?

This is Ground Control to Major Tom
Your pull request looks great
And the Twitters want to know whose theme you use
Now it's time to tell us what’s the font you choose

This is Major Tom to Ground Control
I'm shipping to the cloud
Point-three seconds to my first contentful paint
GitHub stars feel very different today
For here
Am I copying solutions
From Stack Overflow
And there’s nothing I can do

Local Development

Front-End

The frontend is a Next site. Env vars are in Netlify, so work with Netlify Dev for easier local development.

Prerequisites

• Netlify CLI

Instructions

# clone the repo
git clone [email protected]:netlify/explorers.git

# move into the new project
cd explorers/

# install dependencies
npm install

Add the following env vars to .env at the project root:

NEXT_PUBLIC_SANITY_GRAPHQL_URL=https://q8efilev.api.sanity.io/v1/graphql/production/default

This is a read-only GraphQL API to pull Jamstack Explorers missions, stages, and other data.

Start the site locally:

# start the site for local development
npm run dev

The site will open at http://localhost:8888.

OAuth

Right now the OAuth is set up to run through the production site, so you do not need to set up local OAuth.

If you want to try it out, you can create a new OAuth app with a redirect URL of http://localhost:8888/.netlify/functions/auth-callback to allow local OAuth flows and testing.

See .env.EXAMPLE for the required env vars.

Sanity

See the backend README for details on the Sanity setup for this project.

Code Formatting With Prettier

We have a prettier pre-commit hook. To run formatting on the command line:

npm run format

Certificate Generation

Certificate generation is managed through a private repo. If you’re a project maintainer, you’ll need an invite to view it.

How to commit to this repo!

See our contributing guidelines for more info about getting involved!

How to contribute mission!

Thinking about a technology or best practice that you would like to share with the community? Check out our Content Contribution Guide to learn how ✲ ﾟ｡.(✿╹◡╹)ﾉ ☆.｡₀:ﾟ ✲ ﾟ:₀｡