From 519b5f54835601953a00528ea2dfcad06aa736fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zsolt=20Sz=2E=20Sztup=C3=A1k?= Date: Thu, 25 Jan 2024 10:49:42 +0000 Subject: [PATCH] Fix environment setup in new structure The GITHUB TOKEN's environment name has changed recently but this was not reflected in the readme and the .env configs. This change also makes sure that the .env file values are proeprly picked up, and that the README is updated to help new users be able to set up their local dev environment quicker --- .env.example | 4 ++-- README.md | 2 +- org-cyf/README.md | 2 +- org-cyf/package.json | 3 ++- org-mcb/package.json | 4 ++-- 5 files changed, 8 insertions(+), 7 deletions(-) diff --git a/.env.example b/.env.example index b4884d577..91978e795 100644 --- a/.env.example +++ b/.env.example @@ -1,8 +1,8 @@ # Allow accessing a GitHub bearer token to avoid rate limits when doing HTTP fetches to the GitHub API. # This can be generated at https://github.com/settings/tokens?type=beta and needs read-only access to all public CYF GitHub repos. -CYF_CURRICULUM_GITHUB_BEARER_TOKEN="" +HUGO_CURRICULUM_GITHUB_BEARER_TOKEN="" # Client ID and secret for the GitHub OAuth app used to authenticate users. GITHUB_CLIENT_ID="clientid" GITHUB_CLIENT_SECRET="clientsecret" # The domain of the site, used for generating redirect URLs. -DOMAIN="http://localhost:8888" \ No newline at end of file +DOMAIN="http://localhost:8888" diff --git a/README.md b/README.md index db9e06df9..cd8264c13 100644 --- a/README.md +++ b/README.md @@ -57,4 +57,4 @@ For each module you import, add a `replace` directive to your `go.mod` file - if ## To locally develop your site -`cd` into the site you wish to develop, and run `hugo server` to get a live preview. +Check [org-cyf/README.md](/org-cyf/README.md) on how to set up your local environment. Once that is done you can `cd` into the site you wish to develop, and run `npm run start:dev` to get a live preview. diff --git a/org-cyf/README.md b/org-cyf/README.md index 63673bf9e..d5871d16b 100644 --- a/org-cyf/README.md +++ b/org-cyf/README.md @@ -38,7 +38,7 @@ The "Repository access" you need is "Public repositories (read-only)", and you d #### Set up `.env` -Copy the `.env.example` file over and name it `.env`. Edit the file and then change the line that says `CYF_CURRICULUM_GITHUB_BEARER_TOKEN` to contain the token that you have generated earlier. +Copy the `.env.example` file over and name it `.env`. Edit the file and then change the line that says `HUGO_CURRICULUM_GITHUB_BEARER_TOKEN` to contain the token that you have generated earlier. #### Run this command diff --git a/org-cyf/package.json b/org-cyf/package.json index 9a1da90c0..33e4df539 100644 --- a/org-cyf/package.json +++ b/org-cyf/package.json @@ -5,7 +5,8 @@ "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "start:dev": "dotenv -- hugo server -p 3000 -D" + "start:dev": "dotenv -e ../.env -- hugo server --environment issues-are-cached-and-incomplete", + "build:dev": "dotenv -e ../.env -- hugo --environment issues-are-cached-and-incomplete" }, "keywords": [], "author": "", diff --git a/org-mcb/package.json b/org-mcb/package.json index 974d5e95a..33e4df539 100644 --- a/org-mcb/package.json +++ b/org-mcb/package.json @@ -5,8 +5,8 @@ "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "start:dev": "dotenv -- hugo server --environment issues-are-cached-and-incomplete", - "build:dev": "dotenv -- hugo --environment issues-are-cached-and-incomplete" + "start:dev": "dotenv -e ../.env -- hugo server --environment issues-are-cached-and-incomplete", + "build:dev": "dotenv -e ../.env -- hugo --environment issues-are-cached-and-incomplete" }, "keywords": [], "author": "",