diff --git a/README.md b/README.md index cd8264c13..e0d6d2331 100644 --- a/README.md +++ b/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 diff --git a/org-cyf-guides/.env.example b/org-cyf-guides/.env.example new file mode 100644 index 000000000..dbbe14ac8 --- /dev/null +++ b/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" diff --git a/org-cyf-guides/README.md b/org-cyf-guides/README.md index 04f7234a9..2677855d1 100644 --- a/org-cyf-guides/README.md +++ b/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 diff --git a/org-cyf-itp/.env.example b/org-cyf-itp/.env.example new file mode 100644 index 000000000..dbbe14ac8 --- /dev/null +++ b/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" diff --git a/org-cyf-itp/README.md b/org-cyf-itp/README.md index d5871d16b..ddf8e22b0 100644 --- a/org-cyf-itp/README.md +++ b/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 Open to view screenshot of the required permissions ![screenshot of required permissions](./readme_repository_access.png) + #### Set up `.env` diff --git a/org-cyf-piscine/.env.example b/org-cyf-piscine/.env.example new file mode 100644 index 000000000..dbbe14ac8 --- /dev/null +++ b/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" diff --git a/org-cyf-piscine/README.md b/org-cyf-piscine/README.md index 04f7234a9..2677855d1 100644 --- a/org-cyf-piscine/README.md +++ b/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 diff --git a/org-cyf-sdc/.env.example b/org-cyf-sdc/.env.example new file mode 100644 index 000000000..dbbe14ac8 --- /dev/null +++ b/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" diff --git a/org-cyf-sdc/README.md b/org-cyf-sdc/README.md index d5871d16b..fd260007c 100644 --- a/org-cyf-sdc/README.md +++ b/org-cyf-sdc/README.md @@ -15,7 +15,7 @@ ### To install ```bash -brew install hugo +brew install go hugo ``` ### To run locally diff --git a/org-cyf/.env.example b/org-cyf/.env.example new file mode 100644 index 000000000..dbbe14ac8 --- /dev/null +++ b/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" diff --git a/org-cyf/README.md b/org-cyf/README.md index 9cb4adc48..dc89f35c2 100644 --- a/org-cyf/README.md +++ b/org-cyf/README.md @@ -15,7 +15,7 @@ ### To install ```bash -brew install hugo +brew install go hugo ``` ### To run locally