jkspn / coronastatus

๐Ÿ‡ณ๐Ÿ‡ด๐Ÿ‡ณ๐Ÿ‡ฑ๐Ÿ‡ธ๐Ÿ‡ฐ๐Ÿ‡ฉ๐Ÿ‡ฐ๐Ÿ‡จ๐Ÿ‡ด๐Ÿ‡ฎ๐Ÿ‡น๐Ÿ‡ซ๐Ÿ‡ท๐Ÿ‡ฒ๐Ÿ‡ฝ๐Ÿ‡บ๐Ÿ‡ธ๐Ÿ‡บ๐Ÿ‡ฆ๐Ÿ‡ช๐Ÿ‡ธ๐Ÿ‡จ๐Ÿ‡ฆ๐Ÿ‡ฆ๐Ÿ‡บ๐Ÿ‡ธ๐Ÿ‡ฌ๐Ÿ‡ฒ๐Ÿ‡พ๐Ÿ‡ฆ๐Ÿ‡ท๐Ÿ‡ฒ๐Ÿ‡น๐Ÿ‡จ๐Ÿ‡ฑ๐Ÿ‡ฎ๐Ÿ‡ณ๐Ÿ‡ฑ๐Ÿ‡น๐Ÿ‡ณ๐Ÿ‡ต Join the fight! Open source webapp that let people report their health status to get overview of COVID-19

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Coronastatus (archived)

Report your health status to get a better overview of COVID-19 in your country

What is this?

We don't know how many people have COVID-19. So we made a website where people can self-report symptoms. We plot the submissions on a map and show graphs with trends.

How can I help?

We need people who can help translate the site, develop new features, project leads for new and existing countries, and much more. Join our group chat: https://t.me/onzecorona

In what countries have you launched Coronastatus?

Why?

The government is working on this, but they're too slow in getting something out fast.

Mentions in the media

Title Country URL
Self-report system for monitoring COVID19 needs to be in place immediately! ๐Ÿ‡ณ๐Ÿ‡ด Read here
Are you ill? Health services will soon let you self-report symtoms. ๐Ÿ‡ณ๐Ÿ‡ด Read here
Developers take on COVID-19 with open-source projects, hackathons ๐Ÿ‡บ๐Ÿ‡ธ Read here

Who's behind this?

A bunch of developers from around the world that wanted to help out. This is not an official website from the health services.

How can I contribute?

Join our Telegram group chat here: https://t.me/onzecorona or reach out on kontakt@bustbyte.no

Click on "Issues" in the menu above to see what we need help with.

How to launch the site in your country

Adding a new language should be pretty straightforward. If you need help, you can always ask in the Telegram group chat or contact us by email. The following is needed in order to set up a new language:

  • Set up a new config file: cp config.example.json config.json. COUNTRY_CODE should be the Alpha-2-code listed here: https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
  • In app/locales you have to add
    • Translations for all the sentences in en.json. The translations should be placed in {LOCALE}.json (LOCALE should be one of the locales from here). The keys are the same in all the {LOCALE}.json-files, and the values are the translations. We recommend translating everything in the file first, and then testing the site in order to verify that the translations look ok in context. Some texts conains {{ SOME_VALUE }}. The content in {{ }} will be replaced with a country specific variable.
    • sort the locales alphabetically by keys. You can use a helper script to sort it: yarn sort:locales
  • In app/countrySpecific/{COUNTRY-CODE}/ you have to add (follow filename convention of the files that are already there):
    • config.ts. Copy from app/countrySpecific/en/config.ts, and change the values so that it fits your country (ask in Telegram if you wonder what the different values mean).
    • text-variables.ts. Copy from app/countrySpecific/en/text-variables.ts and fill in variables for the country you add. These values will always be rendered, regardless of which locale the user use.
    • A word list that is used for generating unique profile links. If you are ok with english words, you can use this. If the word list contains between 1000 and 10000 words, you should set PASSCODE_LENGTH: 4 in the config. If it contains more than 10000 words, PASSCODE_LENGTH: 3 should be sufficient.
    • List of municipalities (we can help with this Check Here).
    • List of postal code coordinates (we have a script for this Check Here).
  • Configure URL paths in app/domain/urls.ts (set up for the COUNTRY_CODE you added)
  • Write a privacy statement in app/views/privacy-statement/{COUNTRY_CODE}-privacy-statement.ejs.
  • Add a mapping from the locale you added to a corresponding flag in app/domain/flags.ts. The code (two letters) of the flag can be found here.
  • You also need a domain (preferably coronastatus.tld if it is available), and a server to run the app on. We can assist you with setting this up.
  • Generate images for social media etc. using this guide
  • We can host the site for you if you want that. Just send a message to us in Telegram. This makes it easier to maintain and deploy new changes to all the sites. We will give you access to the server as well. If you insist on hosting it yourself, please add your name to the README here

Start developing

You can either install and run everything on your own machine or build a docker image and run the the local development environment using docker. Choose one of the ways below that fits best to you:

Developing on your own machine

Prerequisities

Download & install:

Steps

  1. Clone the repository

git clone https://github.com/BustByte/coronastatus

  1. Move into the newly cloned directory

cd coronastatus

  1. Install dependencies with our package manager

yarn

  1. Create a configuration file from the example provided in this repo.

cp config.example.json config.json

  1. Start the development webserver

yarn dev

  1. Open your browser and navigate to http://localhost:7272/

  2. Before you create a pull request run the linter. Warnings are ok, but errors should be fixed.

yarn lint

Developing using docker

Prerequisities

Download & install:

Steps

  1. Clone the repository

git clone https://github.com/BustByte/coronastatus

  1. Move into the newly cloned directory

cd coronastatus

  1. Create a configuration file from the example provided in this repo

cp config.example.json config.json

  1. Install node modules:

docker-compose run --rm app yarn

  1. Start the development container & display the container logs:

docker-compose up -d; docker-compose logs -f

  1. Open your browser and navigate to http://localhost:7272/

  2. Before you create a pull request run the linter. Warnings are ok, but errors should be fixed.

docker-compose exec app yarn lint

Generating social images

Social images (social media share image, Twitter header and generic banner) can be generated by running yarn build:images while your dev server is running. They will be placed in the static folder, in the language you defined in your config (make sure LOCALE, BASE_URL and COUNTRY_CODE is set correctly). The social-image.png is then automatically linked as social media share image.

Contributors โœจ

We're working on updating this section to include everyone who has devoted time and attention to this project. Stay put!

About

๐Ÿ‡ณ๐Ÿ‡ด๐Ÿ‡ณ๐Ÿ‡ฑ๐Ÿ‡ธ๐Ÿ‡ฐ๐Ÿ‡ฉ๐Ÿ‡ฐ๐Ÿ‡จ๐Ÿ‡ด๐Ÿ‡ฎ๐Ÿ‡น๐Ÿ‡ซ๐Ÿ‡ท๐Ÿ‡ฒ๐Ÿ‡ฝ๐Ÿ‡บ๐Ÿ‡ธ๐Ÿ‡บ๐Ÿ‡ฆ๐Ÿ‡ช๐Ÿ‡ธ๐Ÿ‡จ๐Ÿ‡ฆ๐Ÿ‡ฆ๐Ÿ‡บ๐Ÿ‡ธ๐Ÿ‡ฌ๐Ÿ‡ฒ๐Ÿ‡พ๐Ÿ‡ฆ๐Ÿ‡ท๐Ÿ‡ฒ๐Ÿ‡น๐Ÿ‡จ๐Ÿ‡ฑ๐Ÿ‡ฎ๐Ÿ‡ณ๐Ÿ‡ฑ๐Ÿ‡น๐Ÿ‡ณ๐Ÿ‡ต Join the fight! Open source webapp that let people report their health status to get overview of COVID-19

License:MIT License


Languages

Language:EJS 45.6%Language:TypeScript 35.7%Language:CSS 13.6%Language:HTML 2.6%Language:JavaScript 1.1%Language:Shell 1.0%Language:Python 0.5%Language:Dockerfile 0.0%