Load spatial data

.eslintrc.js

@@ -14,7 +14,7 @@ module.exports = {
   parserOptions: { ecmaVersion: 2024 },
   overrides: [
     {
-      files: ["tests/**/*.js"],
+      files: ["./*.js", "tests/**/*.js"],
       rules: {
         "no-console": 0,
       },

.gitattributes

@@ -0,0 +1,9 @@
+spatial-data/c_05mr24.prj filter=lfs diff=lfs merge=lfs -text
+spatial-data/c_05mr24.shp filter=lfs diff=lfs merge=lfs -text
+spatial-data/c_05mr24.shx filter=lfs diff=lfs merge=lfs -text
+spatial-data/s_05mr24.dbf filter=lfs diff=lfs merge=lfs -text
+spatial-data/s_05mr24.prj filter=lfs diff=lfs merge=lfs -text
+spatial-data/s_05mr24.shx filter=lfs diff=lfs merge=lfs -text
+spatial-data/c_05mr24.dbf filter=lfs diff=lfs merge=lfs -text
+spatial-data/s_05mr24.shp filter=lfs diff=lfs merge=lfs -text
+spatial-data/cities500.txt filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -1,5 +1,4 @@
 /.editorconfig
-/.gitattributes
 
 # Ignore dependencies that are managed with Composer.
 # Generally you should only ignore the root vendor directory. It's important
@@ -94,4 +93,3 @@ credentials-*.json
 
 # Test screenshots
 /tests/**/screenshots/**
-

docker-compose.yml

@@ -10,6 +10,8 @@ services:
       MYSQL_USER: drupal
       MYSQL_PASSWORD: drupal
       MYSQL_ROOT_PASSWORD: drupal
+    ports:
+      - 3306:3306
 
   api-proxy:
     build:

docs/dev/index.md

@@ -9,23 +9,27 @@ caches, importing/exporting, configuration, etc.
 To get up and running quickly with Docker, ensure you have Docker installed and
 then:
 
-1. Clone this repository into a new directory and `cd` into it.
-2. Copy the file at `web/sites/example.settings.dev.php` to
+1. [Install git LFS](spatial-data.md). We use LFS to store large geospatial
+   files. If you clone the repo before installing LFS, you can get your repo
+   up-to-date by running `git lfs pull` after installing.
+2. Clone this repository into a new directory and `cd` into it.
+3. Copy the file at `web/sites/example.settings.dev.php` to
    `web/sites/settings.dev.php` and make any necessary changes.
    > [!NOTE]  
    > As of this writing, no changes are necessary.
-3. Run `make zap` from the command line.  
+4. Run `make zap` from the command line.  
    This command will first attempt to destroy any weather.gov 2.0 containers you
    have, so you may notice some warnings on the command line. It is safe to
    ignore those warnings. After the warnings, it will build all of the necessary
    containers, create a Drupal site with our configuration, and populate the
    site with our content.
-4. Run `npm ci` from the command line.  
+5. Run `npm ci` from the command line.  
    This installs our Javascript and Sass code linters and formatters, as well as
    Cypress, which is necessary for end-to-end and accessibility testing.
-5. Browse to [http://localhost:8080](http://localhost:8080) in your broswer. You
+6. [Load necessary geospatial data](spatial-data.md) into your database.
+7. Browse to [http://localhost:8080](http://localhost:8080) in your broswer. You
    should see our front page! Congrats!
-6. Browse to [http://localhost:8080/user/login](http://localhost:8080/user/login)
+8. Browse to [http://localhost:8080/user/login](http://localhost:8080/user/login)
    to log in. Your username is `admin` and your password is `root`. Then you can
    do stuff!
 

docs/dev/spatial-data.md

@@ -0,0 +1,43 @@
+# Spatial data
+
+We store certain geospatial data in our own database and use it for some basic
+geospatial queries. In order for the site to work correctly locally, the data
+needs to be loaded first. The spatial data is stored in our repo using
+[git LFS](https://www.atlassian.com/git/tutorials/git-lfs).
+
+1. Install and enable git LFS.
+
+   - **Linux**: [download instructions](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage?platform=linux)
+   - **Windows**: [download instructions](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage?platform=windows)
+   - **macOS**: the easiest way is to use Homebrew and run
+     ```sh
+     brew install git-lfs
+     ```
+     Alternatively, there are manual [download instructions](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage?platform=mac).
+
+2. Enable git LFS on your local machine by running
+
+   ```sh
+   git lfs install
+   ```
+
+3. Load the spatial data into your local database by running
+   ```sh
+   node load-shapefiles.js
+   ```
+
+## Loading data into cloud environments
+
+Ensure you have the spatial data in your project in the `spatial-data` directory.
+If not, run `git lfs pull` to fetch it. Then, log into cloud.gov:
+
+```sh
+ cf login --sso -a api.fr.cloud.gov
+```
+
+And then run this utility script, indicating which environment you want to load
+data into.
+
+```sh
+./scripts/load-spatial-data.sh <environment>
+```