-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #482 from Klimatbyran/staging
Release to production: * add Alex to team * update readme * remove Postkodsstiftelsen from supporters
- Loading branch information
Showing
11 changed files
with
190 additions
and
174 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,23 +2,29 @@ | |
|
||
This is the official source code for [klimatkollen.se](https://klimatkollen.se). | ||
|
||
## About | ||
## Free our climate data! | ||
|
||
Free our climate data! Klimatkollen is an open source and citizen-driven climate data platform aimed at visualising local climate data. | ||
Klimatkollen is an open source and citizen-driven climate data platform aimed at visualising local climate data in Sweden. | ||
|
||
<b>The</b> problem: Most of Sweden’s 290 cities and municipalities are not slashing carbon emissions fast enough to be in line with the Paris Agreement. Furthermore, climate data that can help us is often locked behind paywalls or sits in complex government databases. If we can’t clearly see how much CO2 is being emitted, from which sources and how quickly we need to decarbonise – we can’t create a public opinion strong enough to change the course of our future. | ||
<b>The problem:</b> Sweden’s 290 cities and municipalities are not slashing carbon emissions fast enough to be in line with the Paris Agreement. Climate data that can help us is often locked behind paywalls, or sits in complex government databases. If we can’t clearly see how much CO<sup>2</sup> is being emitted, from which sources and how quickly we need to decarbonise – we can’t create a public opinion strong enough to change the course of our future. This needs to change. | ||
|
||
This needs to change. | ||
That’s why we’re building a data-driven movement of climate-savvy developers to help us find and visualise climate data for the public. Climb aboard! | ||
|
||
That’s why we’re building a data-driven movement of climate-savvy developers to help us find and visualise climate data for the public. | ||
<b>Join our [Discord](https://discord.gg/N5P64QPQ6v)</b> and set our climate data free! | ||
|
||
Please climb onboard to help us set our climate data free! #Klimatkollen /#FreeClimateData | ||
#Klimatkollen #FreeClimateData | ||
|
||
## Get started | ||
## Climate Data Pipeline Overview | ||
|
||
Please see full [description here](data/README.md). | ||
|
||
Feel free to explore the repository to understand more about how we collect, process, and display climate data. | ||
|
||
## Building and running locally | ||
|
||
Detailed step-by-step setup instructions, including getting the code and installing dependencies, can be found in [doc/getting-started.md](doc/getting-started.md). | ||
If your're starting from scratch, and working with GitHub, NodeJS and so on is new to you, read [doc/getting-started.md](doc/getting-started.md). | ||
|
||
We use next.js and Typescript and it's pretty straightforward to get started. Just clone the repo and run: | ||
We use next.js and Typescript and it's pretty straightforward to get started. After cloning the repo run: | ||
|
||
npm ci | ||
npm run dev | ||
|
@@ -33,24 +39,19 @@ The project can also be run with docker (although with much slower refresh time) | |
# starts the container | ||
docker run -t -i --rm -p 3000:3000 --name klimatkollen klimatkollen | ||
|
||
|
||
## Contribute | ||
## Contributing | ||
|
||
The idea behind Klimatkollen is to give citizens access to the climate data we need to meet the goals of the Paris Agreement – and save our own future. | ||
|
||
Do you have an idea for a feature you think should be added to the project? Please develop it and create a pull request where you explain what you've done. If you can't develop the feature yourself, please submit an [issue](https://github.com/Klimatbyran/klimatkollen/issues) where you explain your suggestion. | ||
|
||
Looking for ideas on what needs to be done? Take a look at our [issues](https://github.com/Klimatbyran/klimatkollen/issues) and/or [pull requests](https://github.com/Klimatbyran/klimatkollen/pulls). Testing, bug fixes, typos or fact checking our data is highly appreciated. | ||
|
||
Feedback? Either submit an [issue](https://github.com/Klimatbyran/klimatkollen/issues) or send an email to [[email protected]](mailto:[email protected]). | ||
Do you have an idea for a feature you think should be added to the project? Before jumping into the code, it's a good idea to discuss your idea in the Discord server. That way you can find out if someone is already planning work in that area, or if your suggestion aligns with other people's thoughts. You can always submit an [issue](https://github.com/Klimatbyran/klimatkollen/issues) explaining your suggestion. We try to review the issues as soon as possible, but be aware that the team is at times very busy. Again, feel free to ask for a review on Discord! | ||
|
||
Please star this repo if you want to follow the progress and feel free to join our [Discord](https://discord.gg/N5P64QPQ6v). | ||
Looking for ideas on what needs to be done? We appreciate help on existing [issues](https://github.com/Klimatbyran/klimatkollen/issues) very much. If you pick one up, remember to leave a comment saying you're working on it, and roughly when you expect to report progress. This helps others avoid double work and know what to expect. | ||
|
||
## Climate Data Pipeline Overview | ||
Testing, bug fixes, typos or fact checking of our data is highly appreciated. | ||
|
||
Please see full [description here](data/README.md). | ||
## Contact | ||
|
||
Feel free to explore the repository to understand more about how we collect, process, and display climate data. | ||
Join the Discord server in the introduction or send an email to [[email protected]](mailto:[email protected]). | ||
|
||
## Supporters and Partners | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.