Fix install instructions (CodeYourFuture#831)

* Add note about where to look for site setup instructions

* Add Go to homebrew install

Go is now required as we're using Hugo modules, likely as they use Go modules underneath.

* Add .env.example files

These are referenced in the READMEs, and it is required to use the Github token, so is necessary for set up.

* Remove MigraCode as they moved to own repo

Co-authored-by: Sally McGrath <[email protected]>

* Improve example env

---------

Co-authored-by: Sally McGrath <[email protected]>

README.md

@@ -15,7 +15,10 @@ Each org builds its own Hugo site that uses the common theme and content modules
 ## Examples
 
 - [CodeYourFuture](/org-cyf/) => [https://org-cyf-theme.netlify.app/](https://org-cyf-theme.netlify.app/)
-- [MigraCode](/org-mcb/) => [https://org-mcb-theme.netlify.app/](https://org-mcb-theme.netlify.app/) (couldn't find an svg logo)
+
+## Developing a site
+
+To develop a specific site, `cd` into the relevant sub-directory and follow the instructions in the `README.md` file.
 
 ## To build a new site
 

org-cyf-guides/.env.example

@@ -0,0 +1,10 @@
+# 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.
+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:1313"

org-cyf-guides/README.md

@@ -21,7 +21,7 @@ path = "github.com/CodeYourFuture/curriculum/org-cyf-piscine"
 ### To install
 
 ```bash
-brew install hugo
+brew install go hugo
 ```
 
 ### To run locally

org-cyf-itp/.env.example

@@ -0,0 +1,10 @@
+# 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.
+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:1313"

org-cyf-itp/README.md

@@ -15,7 +15,7 @@
 ### To install
 
 ```bash
-brew install hugo
+brew install go hugo
 ```
 
 ### To run locally
@@ -34,6 +34,7 @@ The "Repository access" you need is "Public repositories (read-only)", and you d
 <summary>Open to view screenshot of the required permissions</summary>
 
 ![screenshot of required permissions](./readme_repository_access.png)
+
 </details>
 
 #### Set up `.env`

org-cyf-piscine/.env.example

@@ -0,0 +1,10 @@
+# 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.
+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:1313"

org-cyf-piscine/README.md

@@ -21,7 +21,7 @@ path = "github.com/CodeYourFuture/curriculum/org-cyf-piscine"
 ### To install
 
 ```bash
-brew install hugo
+brew install go hugo
 ```
 
 ### To run locally

org-cyf-sdc/.env.example

@@ -0,0 +1,10 @@
+# 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.
+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:1313"

org-cyf-sdc/README.md

@@ -15,7 +15,7 @@
 ### To install
 
 ```bash
-brew install hugo
+brew install go hugo
 ```
 
 ### To run locally

org-cyf/.env.example

@@ -0,0 +1,10 @@
+# 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.
+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:1313"

org-cyf/README.md

@@ -15,7 +15,7 @@
 ### To install
 
 ```bash
-brew install hugo
+brew install go hugo
 ```
 
 ### To run locally