Skip to content

chore: Add README, .nvmrc, and package.json scripts for local dev setup#17

Open
anyelopetit wants to merge 1 commit into
mainfrom
chore/dev-setup-and-readme
Open

chore: Add README, .nvmrc, and package.json scripts for local dev setup#17
anyelopetit wants to merge 1 commit into
mainfrom
chore/dev-setup-and-readme

Conversation

@anyelopetit

Copy link
Copy Markdown
Collaborator

Add README, .nvmrc, and package.json scripts for local developer setup

The hellotext/help repo had no README, no Node version file, and no runnable scripts. A new contributor had no documented path to install, serve, or build the site locally.

What this adds

File Change
README.md New — prerequisites, install, serve, build, project structure, "adding a guide" walkthrough, deployment notes.
.nvmrc New — pins Node 18, matching NODE_VERSION in netlify.toml.
package.json Adds scripts block (setup, serve, build). No dependency changes.

New scripts

"scripts": {
  "setup": "bundle install && yarn install",
  "serve": "bundle exec jekyll serve",
  "build": "JEKYLL_ENV=production bundle exec jekyll build"
}

yarn build is the repeatable verification command — it runs the exact same command Netlify runs (see netlify.toml).

Why JEKYLL_ENV=production is required

Plain bundle exec jekyll build fails with:

Could not connect to the PostCSS server

The jekyll-postcss plugin expects its dev server when serving locally. For a one-off build you must set JEKYLL_ENV=production. This is documented in the README under the Gotcha callout so contributors aren't surprised.

@anyelopetit anyelopetit self-assigned this Jun 12, 2026
@netlify

netlify Bot commented Jun 12, 2026

Copy link
Copy Markdown

Deploy Preview for legendary-lollipop-e2d131 ready!

Name Link
🔨 Latest commit c6cac16
🔍 Latest deploy log https://app.netlify.com/projects/legendary-lollipop-e2d131/deploys/6a2c6adddeacfa00081a653b
😎 Deploy Preview https://deploy-preview-17--legendary-lollipop-e2d131.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant