Add further instructions for Windows users

[rails.git] / DOCKER.md

diff --git a/DOCKER.md b/DOCKER.md
index e2c2d2129cae324cd72ae24d95d50d5d33d80838..52036327d5bbff5eaa44d28242c88ccfa97f69cf 100644 (file)
--- a/DOCKER.md
+++ b/DOCKER.md
@@ -5,7 +5,9 @@ These instructions are designed for setting up The Rails Port for development an
 - [Install Docker](https://docs.docker.com/install/)
 - [Install Docker Compose](https://docs.docker.com/compose/install/)
 
 - [Install Docker](https://docs.docker.com/install/)
 - [Install Docker Compose](https://docs.docker.com/compose/install/)
 

-The first step is to fork/clone the repo to your local machine:
+**Windows users: You must enable symlinks before cloning the repository.** This repository uses symbolic links that are not enabled by default on Windows. To enable them, [turn on Developer Mode](https://windowsreport.com/windows-11-developer-mode/) on Windows and run `git config --global core.symlinks true` to enable symlinks in Git. See [this StackOverflow question](https://stackoverflow.com/questions/5917249/git-symbolic-links-in-windows) for more information.
+
+The first step is to fork/clone the repo to your local machine.

 
     git clone https://github.com/openstreetmap/openstreetmap-website.git
 
 
     git clone https://github.com/openstreetmap/openstreetmap-website.git
 


@@ -29,6 +31,8 @@ This is a workaround. [See issues/2185 for details](https://github.com/openstree
 
     touch config/settings.local.yml
 
 
     touch config/settings.local.yml
 

+**Windows users:** `touch` is not an availible command in Windows so just create a `settings.local.yml` file in the `config` directory, or if you have WSL you can run `wsl touch config/settings.local.yml`.
+

 ## Installation
 
 To build local Docker images run from the root directory of the repository:
 ## Installation
 
 To build local Docker images run from the root directory of the repository:


@@ -56,13 +60,7 @@ Run the Rails database migrations:
 
 Run the test suite by running:
 
 
 Run the test suite by running:
 

-    docker-compose run --rm web bundle exec rake test:db
-
-### Node Modules
-
-Install required front-end Node modules:
-
-    docker-compose run --rm web bundle exec rake yarn:install
+    docker-compose run --rm web bundle exec rails test:all

 
 ### Loading an OSM extract
 
 
 ### Loading an OSM extract
 


@@ -77,12 +75,25 @@ You can now use Docker to load this extract into your local Docker-based OSM ins
     docker-compose run --rm web osmosis \
         -verbose    \
         --read-pbf district-of-columbia-latest.osm.pbf \
     docker-compose run --rm web osmosis \
         -verbose    \
         --read-pbf district-of-columbia-latest.osm.pbf \

+        --log-progress \

         --write-apidb \
             host="db" \
             database="openstreetmap" \
             user="openstreetmap" \
             validateSchemaVersion="no"
 
         --write-apidb \
             host="db" \
             database="openstreetmap" \
             user="openstreetmap" \
             validateSchemaVersion="no"
 

+**Windows users:** Powershell uses ` and CMD uses ^.
+
+    docker-compose run --rm web osmosis `
+        -verbose    `
+        --read-pbf district-of-columbia-latest.osm.pbf `
+        --log-progress `
+        --write-apidb `
+        host="db" `
+        database="openstreetmap" `
+        user="openstreetmap" `
+        validateSchemaVersion="no"
+

 Once you have data loaded for Washington, DC you should be able to navigate to [`http://localhost:3000/#map=12/38.8938/-77.0146`](http://localhost:3000/#map=12/38.8938/-77.0146) to begin working with your local instance.
 
 ### Additional Configuration
 Once you have data loaded for Washington, DC you should be able to navigate to [`http://localhost:3000/#map=12/38.8938/-77.0146`](http://localhost:3000/#map=12/38.8938/-77.0146) to begin working with your local instance.
 
 ### Additional Configuration