The "behind the scenes" of the ClimateTown Knowledge Hub, your "one stop shop" for important climate resources in the fight against climate change!
TLDR; Create an issue, or edit the content directly and make a pull request.
All contributions welcome! Everything from:
- suggestions
- fixing typos
- writing content
- helping with website development
- discussing content on the hub (check out the channels on Discord for this!)
The following sections go through how you can make different contributions. These will require you having a GitHub account.
For any discussion or questions about the Knowledge Hub, join us in #💬knowledge-hub-discussion in the ClimateTown Discord.
Resources data (title, URL, description, tags) are stored in the data/resources.yml file, which is then used to populate the resource on the website. To make small edits, you can directly edit this file or you can create an issue.
To suggest changes anywhere else in the site, you can use GitHub's search functionality to find the exact file which to suggest the change.
We're always looking to publicise awesome climate resources. Got a resource to share? The easiest way is to create an issue, filling out the "resource suggestion" form. This will create a discussion around the resource, and if it's a good fit for the Knowledge Hub, we'll add it to the site.
This website is powered by coders from the community. Have a suggestion to make the site better? Create an issue and we'll discuss it! If the feature sounds good, we'll look at adding it to the site. The feature is much more likely to be added if you are willing to help with the development.
The site is built using Svelte and SvelteKit. A dev environment can be easily set up using Node and npm:
- install Node and npm
git clone https://github.com/ClimateTown/knowledge-hub.gitcdinto the cloned directorynpm installnpm run dev
Some of the tools in the codebase (eg. YouTube API, JSON schema validation) use Python. For most changes to the site Python is not required.
To set up Python:
- install Python from here if you haven't already (minimum version 3.7)
- create a virtual environment, then activate it (optional, but recommended)
python -m venv venv- activate the environment using either:
source venv/bin/activate(Linux/MacOS)venv\Scripts\activate.bat(Windows)
pip install -r requirements.txt
This codebase uses pip-tools to manage dependencies. If you add a new dependency, you can add it to requirements.in and run pip-compile to update requirements.txt. To update your environment run pip-sync.
To set up the YouTube API (important for working on scripts with YouTube video scraping):
- Follow the python installation steps above
- Go to https://console.cloud.google.com and create account
- Go to https://console.cloud.google.com/apis/credential
- Make an API Key: Create Credentials > API Key
- Enable Youtube API v3 https://console.cloud.google.com/marketplace/product/google/youtube.googleapis.com
- Make a .env file in root folder (where this file is)
- Add YOUTUBE_API_KEY=YourApiKeyHere
- Run python scripts/youtube.py
This codebase uses pre-commit and pre-commit CI to run linting on code, format Python code, and generally have help with code quality.
You can either set up pre-commit locally (completely optional; it will run on every commit, aborting a commit if the pre-commit workflow fails), or you do nothing and leave it up to pre-commit CI to take care of it (where it will run on every push to GitHub, and fixes changes in PRs).
To set up pre-commit locally:
- install the Python environment (which includes pre-commit)
pre-commit installto install the hooks
To run pre-commit manually (without making a commit), use pre-commit run --all-files. If you want to stop using pre-commit locally, just do pre-commit uninstall.
This project follows the all-contributors specification. Contributions of any kind are welcome!
- Twemoji for emoji support