Skip to content

Latest commit

 

History

History
137 lines (87 loc) · 5.61 KB

README.md

File metadata and controls

137 lines (87 loc) · 5.61 KB
Raw

EqualStreetNames City Template

If you want to replicate the EqualStreetNames project in your city, here is the how-to !

Setup

  1. Click on the "Use this template" button above

  2. Update the Overpass queries :

    overpass/relation-full-json.overpassql (example for Brussels, Belgium)

    - ( area["admin_level"=""]["wikidata"=""]; )->.a;
+ ( area["admin_level"="4"]["wikidata"="Q240"]; )->.a;

    overpass/way-full-json.overpassql (example for Brussels, Belgium)

    - ( area["admin_level"=""]["wikidata"=""]; )->.a;
+ ( area["admin_level"="4"]["wikidata"="Q240"]; )->.a;

  3. Find the OpenStreetMap relation of your city (example, Brussels, Belgium)

  4. Update config.php configuration file

    1. REQUIRED: Add relation identifier (example for Brussels, Belgium).

      - 'relationId' => 0,
+ 'relationId' => 54094,

    2. Optional: Choose languages in which you want to extract Wiki informations with languages (English en by default).

    3. Optional: You can exclude ways or relations by adding the ways identifier in exclude.way and adding the relations identifier in exclude.relation.

    4. Optional: You can manually assign a gender to a way or a relation by adding the ways identifier and its gender in gender.way and adding the relations identifier and its gender in gender.relation. You can also use data.csv file to assign gender (and details) to a way or relation (see below).

    5. Optional: You can change the Wikidata instances that will be counted as "a person" with instances.

  5. You can link information to a relation or way using a data.csv CSV file (see Brussels, Belgium CSV file)

    Structure:

    • type: OpenStreetMap object type (relation/way)
    • id: OpenStreetMap object identifier
    • name: OpenStreetMap street name
    • gender: Gender
    • person: Name of the person
    • description: Description of the person

  6. Update the HTML files (replace MyCity by the name of your city in all index.html files, add languages, ...).

    (example for Brussels, Belgium)

    - <title>EqualStreetNames.MyCity</title>
+ <title>EqualStreetNames.Brussels</title>

- <div id="loader-title">EqualStreetNames.MyCity</div>
+ <div id="loader-title">EqualStreetNames.Brussels</div>

- <a class="navbar-brand" href="#">EqualStreetNames.MyCity</a>
+ <a class="navbar-brand" href="#">EqualStreetNames.Brussels</a>

  7. Optionally you can change the style using data-style attribute, it can be a Mapbox pre-defined style (see API Reference) or your custom style (see Style Specification).

    - <div id="map"></div>;
+ <div id="map" data-style="mapbox:https://styles/mapbox/dark-v10"></div>;

Integrate your city to the project

  1. Let us know you're ready to add a new city to the project by opening a new issue.

  2. You have 2 options:

    1. Transfer your repository to the EqualStreetNames organization.

      If you choose to do so, you stay of course "owner" of the repository, we'll create a team for you (and anyone you want) that will have admin rights on your repository.
      We'll help you maintain and manage your repository.
      We'll also setup an automated data update (once a month) and automated deployment of the website (if you need it). If you want more regular updates, you will need to create an ACCESS_TOKEN in your repository secrets with your GitHub access token.

      For the automated deployment, you will need to create a MAPBOX_TOKEN in your repository secrets (see Mapbox documentation).

    2. Keep the ownership of your repository.

      We'll just link your repository as sub-module in the cities folder.
      You'll have to maintain your repository, update the data, and the sub-module yourself.

Run your city locally

  1. Clone the main repository

    git clone https://github.com/EqualStreetNames/equalstreetnames.git

  2. Copy/Link your repository in the cities folder of the main repository (cities/my-country/my-city).

  3. Run the data update (in the process folder of the main repository)

    cd process/
composer install
composer run update-data -- --city=my-country/my-city

  4. Run the website locally (in the root folder of the main repository)

    1. Add your city in the "scripts" section of the website/package.json file

      + "build:my-country:my-city": "node build.js -c my-country/my-city"

    2. Create a Mapbox token

    3. Create a file named .env in the website directory of the project

    4. Add the following line to the .env file: MAPBOX_TOKEN=[your Mapbox token] replacing [your Mapbox token] with the token you created

    5. Install JavaScript dependencies and run it (in the website folder of the main repository)

      cd website/
npm install
npm run build:my-country:my-city -- --serve

  5. Open https://localhost:1234/