Skip to content
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

docs: update README for Directus prereq #101

Merged
merged 1 commit into from
Aug 27, 2024
Merged

docs: update README for Directus prereq #101

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
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
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
```
```
Loading