Skip to content

docs: update README.md #511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MichaelCurrin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update README.md #511

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 24 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
🚀👩‍🚀👨‍🚀<br />
Jamstack Explorers
</h1>

<p align="center">Presented by Netlify</p>

Ground Control to Major Tom
Expand All @@ -27,43 +28,47 @@ And there’s nothing I can do

## Local Development

### Front-End
### Frontend

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

#### Prerequisites
#### Requirements

- [Node.js](https://nodejs.org/)
- [Netlify CLI](https://docs.netlify.com/cli/get-started/#installation)

#### Instructions

```bash
# clone the repo
git clone git@github.com:netlify/explorers.git
#### Installation

# move into the new project
cd explorers/
1. Install Node.
1. Clone the repo.
```sh
git clone git@github.com:netlify/explorers.git
cd explorers/
```
1. Install project packages.
```sh
npm install
```

# install dependencies
npm install
```
#### Configuration

Add the following env vars to `.env` at the project root:
Add the following environment variable to a `.env` file 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:
#### Usage

Start the server for local development:

```sh
# start the site for local development
npm run dev
```

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

### OAuth

Expand All @@ -75,7 +80,7 @@ See `.env.EXAMPLE` for the required env vars.

### Sanity

See [the backend README](./backend/README.md) for details on the Sanity setup for this project.
See [the backend README](/backend/README.md) for details on the Sanity setup for this project.

### Code Formatting With Prettier

Expand All @@ -91,7 +96,7 @@ Certificate generation is managed through a [private repo](https://github.com/sd

## How to commit to this repo!

See our [contributing guidelines](./CONTRIBUTING.md) for more info about getting involved!
See our [contributing guidelines](/CONTRIBUTING.md) for more info about getting involved!

## How to contribute mission!

Expand Down