Skip to content

Commit

Permalink
Update README to make current
Browse files Browse the repository at this point in the history
  • Loading branch information
wesley-dean-gsa committed Aug 27, 2024
1 parent 02bf010 commit ae0691f
Showing 1 changed file with 6 additions and 40 deletions.
46 changes: 6 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,51 +31,17 @@ The standards require that a website or digital service:

`npm install`

### Running a Dev Instance

`npm run dev`

## Netlify CMS
### Building the Assets

`npm run build`

### Config

The Netlify CMS can be configured in [`/admin/config.yml`](./admin/config.yml) and you will update the
`repo` key to be your Github organization and repository name.

```YAML
backend:
name: github
repo: <your-github-org>/<your-repository-name>
base_url: https://federalistapp.18f.gov
auth_endpoint: external/auth/github
preview_context: federalist/build
branch: main
use_graphql: true
```
### Running Locally
You can run the Netlify CMS locally to more easily customize and troubleshoot
the CMS to you content.
We provide comments in the [/admin/config.yml](./admin/config.yml)
instructing you how to change the `backend` values from your production site
to the local development.
### Running a Dev Instance

> *Note:* Make sure to not commit and push the config with the `backend`
set for local develop to Github or else you will break your production site's
Netlify CMS.
`npm run serve`

```YAML
# Local development backend
backend:
name: git-gateway
local_backend: true
```
#### Accessing the Dev Instances

Once your [/admin/config.yml](./admin/config.yml) is set to local development,
you run `npm run dev:cms` to serve as a development authentication server.
Point your browser to [http://localhost:3000/](http://localhost:3000/)

## How To

Expand Down

0 comments on commit ae0691f

Please sign in to comment.