Skip to content

Commit

Permalink
docs: update README for Directus prereq
Browse files Browse the repository at this point in the history
  • Loading branch information
nickcernera committed Aug 27, 2024
1 parent 92abf62 commit a6196bf
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,17 @@ Built with [Next.js](https://nextjs.org/) and [Markdoc](https://markdoc.dev/).

## Contributing


### Running the site locally

To run the site locally, you'll need to have yarn and node as prerequisites. Then run the following commands:
To start, you'll need to receive an access token from Plural's Directus:
1. Request access to Directus, then login at https://directus.plural.sh
2. Generate an access token at the bottom of Profile > Administrator.
3. Run `export DIRECTUS_ACCESS_TOKEN={your-access-token}`

Then, to run the site locally, you'll need to have yarn and node as prerequisites. Then run the following commands:

```shell
yarn # build the environment
yarn dev # run site locally
```
```

0 comments on commit a6196bf

Please sign in to comment.