Giter Club home page Giter Club logo

locally-informed's Introduction

Locally Informed — Official Resources by Location

Covid-19 is causing considerable disruption worldwide and a lot of people don't know where to find information about the measures taken by their local governments.

We created Locally Informed to help people identify all the key information relevant to their city, state/province, and nation.

Users can go to local.quarantinesupport.com to find all their relevant official sources. This is useful for people to get dialed-in to the right information sources and for other application developers, media, and institutions to help people stay on top of announcements for their region.

We're crowdsourcing the official information by location right now — you can make a difference by adding your local data and telling others about the project. This project was led up by Ultraworking's CTO, Lee Knowlton — we're turning all our attention to helping people affected by lockdown, quarantine, and who have disrupted routines during the Pandemic.

It only takes 5-10 minutes to update data and can make a considerable difference in helping people get informed.

Our motto for this time period is "Parati Servire" — we're here to serve.

Thank you for helping and for spreading the word. Stay safe and strong out there,

Lee Knowlton CTO, Ultraworking

Updates

9th April 2020

  • regions for India have been updated from City-level to State-level.

Directory Structure

Directory Structure

  • [COUNTRY_ISO_CODE]: The 3-Letter ISO Alpha-3 code for the target country. (Example — nzl for New Zealand).
  • [REGION_NAME]: For USA, this will be the 2-Letter State code. (Example — ca for California). For all other countries, this will be the name of the target city. Note: If the name has a space, replace that with the _ character. (Example — kuala_lumpur for Kuala Lumpur City, Malaysia).

NOTE: both the [COUNTRY_ISO_CODE] and [REGION_NAME] should be in lower case.

Contribution Guide — USA

To get started, you will first need to fork and clone the repository. If you are not familiar with contributing to public projects on GitHub the instructions can be found here.

You will then want to navigate to the regions folder. (locally-informed/countries/usa/regions).

1. Add resources to an existing data source for a State:

  • Find the JSON file for the State by searching for its 2-Letter State Code. (Example — ca.json for California).
  • Open the JSON file using a text editor and add the resources by following the file structure.
  • Save the file and commit and push to a branch in your cloned repository.
  • Submit a Pull Request to the locally-informed repository.

2. Create a data source and add resources for a State:

Note: Make sure that a data source does not already exist for the State

  • Copy the region_template.json file from locally-informed/templates.
  • Paste the copied region_template.json file into locally-informed/countries/usa/regions.
  • Rename the file with the 2-Letter State Code. Example — tx.json for Texas.
  • Open the template and follow the structure to add resources. You can use data sources for other States as reference.
  • Save the file and commit and push to a branch in your cloned repository.
  • Submit a Pull Request to the locally-informed repository.

Contribution Guide — Rest of the World

To get started, you will first need to fork and clone the repository. If you are not familiar with contributing to public projects on GitHub the instructions can be found here.

1. Add resources to an existing data source for a Country:

  • Find the JSON file for the Country by searching for its 3-Letter ISO Alpha-3 code. (Example — deu.json for Germany).
  • Open the JSON file using a text editor and add the resources by following the file structure.
  • Save the file and commit and push to a branch in your cloned repository.
  • Submit a Pull Request to the locally-informed repository.

2. Create a data source and add resources for a Country:

Note: Make sure that a data source does not already exist for the Country

  • Copy the country_template.json file from locally-informed/templates.
  • Create a new folder inside locally-informed/countries.
  • Rename the folder with the 3-Letter ISO Alpha-3 code. (Example — ita for Italy).
  • Paste the copied country_template.json file into the created folder.
  • Rename the file with the 3-Letter ISO Alpha-3 code. (Example — ita.json for Italy).
  • Open the template and follow the structure to add resources. You can use data sources for other Countries as reference.
  • Save the file and commit and push to a branch in your cloned repository.
  • Submit a Pull Request to the locally-informed repository.

3. Add resources to an existing data source for a City:

  • Find the JSON file for the City by searching for its City name inside locally-informed/countries/[COUNTRY_NAME]/regions. (Example — warsaw.json for Warsaw, Poland).
  • Open the JSON file using a text editor and add the resources by following the file structure.
  • Save the file and commit and push to a branch in your cloned repository.
  • Submit a Pull Request to the locally-informed repository.

4. Create a data source and add resources for a City:

Note: Make sure that a data source does not already exist for the City

  • Copy the region_template.json file from locally-informed/templates.
  • Paste the copied region_template.json file into locally-informed/countries/[COUNTRY_NAME]/regions.
  • Rename the file with the respective city name. (Example — auckland.json for Auckland, New Zealand).
  • Open the template and follow the structure to add resources. You can use data sources for other Cities as reference.
  • Save the file and commit and push to a branch in your cloned repository.
  • Submit a Pull Request to the locally-informed repository.

locally-informed's People

Contributors

a1smiley avatar adhearn avatar ameyaraje avatar andrewviren avatar camwiese avatar corinnpope avatar cyberhobo avatar d-brgr avatar delmania avatar dingdongkid avatar evgeniypd95 avatar indian99 avatar jeswsi avatar jperezmacias avatar kolevdarko avatar lawrenceevalyn avatar leeknowlton avatar lorenzosantos avatar lukaskawerau avatar mayeu avatar mislavjuric avatar saadzafar avatar santoshkhembram avatar stephencweiss avatar tnorthcutt avatar tomdaly avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

locally-informed's Issues

Buttons not working

Get Involved, Contact Us, and Enlist Today buttons on main page not working (broken).

Resources for Indian cities don't show up

Steps to reproduce:

  1. Enter any Indian city (e.g. Mumbai or Bangalore/Bengaluru).

At this point, resources for these cities should show up. The .json files for their states have been added, but they don't appear.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.