Skip to content

Commit

Permalink
Updates to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jashlu committed Dec 8, 2023
1 parent c7f41d1 commit 435673e
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,45 @@ A usage of
[gatsby-theme-project-portal](https://github.com/thepolicylab-projectportals/project-portal-theme)
for the (fictional) State of Quinetucket.

The set of instructions below can be applied to any respective partner's Project Portal repository to spin up a local version of the respective Project Portal site.

## Quick Start Guide

Clone the repo
```shell
git clone https://github.com/thepolicylab-projectportals/example-content.git
```
Run the following command to install the required dependencies.

Run
```shell
yarn install
```

Afterwards, run the following command to generate a production-ready version of your website. Currently, the production-ready version is required to enable the site-wide `Search` feature.
```shell
yarn
yarn build
```

then
Once the build process is completed, run the following command to preview the production build locally.
```shell
yarn develop
yarn serve
```

## Accessing the Developer CMS
## Accessing Decap CMS

Change static/admin/config.yml
Navigate to [static/admin/config.yml](./static/admin/config.yml) and make the following change locally:

```yaml
local_backend: true
```
Run in a second terminal
Spin up the `decap-server` in a separate terminal by running the following command.

```shell
npx decap-server
```

### Enabling users to access Netlify CMS
### Enabling users to access Decap CMS
Add the users to the "Identity" tab in the Netlify CMS UI.
You also need to activate:
- Any external providers which are wanted: GitHub or Google are commonly used at CCV.
Expand Down

0 comments on commit 435673e

Please sign in to comment.