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

Clarify install section to include Begin CLI installation #121

Merged
merged 1 commit into from
Oct 25, 2023
Merged

Clarify install section to include Begin CLI installation #121

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
5 changes: 1 addition & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,12 @@ If there is no Markdown file that matches the path, a 404 error will be returned

- clone this repo
- `npm i`
- install the Begin CLI, see instructions [here](https://begin.com/docs/getting-started/installing-the-begin-cli)

## Setup

If you need to run/test the mailing list subscription action (`POST /signup`) you will need to configure the following environment variables: `CIO_SITE_ID`, `CIO_API_KEY`, `CIO_APP_KEY`

### Begin Setup

Once again this app uses [Begin](https://begin.com) for its deployments. You will have to install the Begin CLI before running the start script as outlined [here](https://begin.com/docs/getting-started/installing-the-begin-cli).

## Run dev server

`npm start`
Expand Down