Update README with simplified instructions (including Windows setup) (#956)

* Add Windows docker troubleshooting link to README

Addresses the docker error I was encountering

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

* Update link

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

* Add more Windows OS notes

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

* Remove sections on docker-compose and running directly

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

* Update devcontainer.json with elixirLS settings

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

* Replace docker-compose with docker compose

Addresses a PR comment

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

* Revert unnecessary sentence.

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

---------

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>

Author: dthaler

.devcontainer/devcontainer.json

@@ -17,7 +17,7 @@
 
   // The optional 'workspaceFolder' property is the path VS Code should open by default when
   // connected. This is typically a file mount in .devcontainer/docker-compose.yml
-  "workspaceFolder": "/app"
+  "workspaceFolder": "/app",
 
   // Features to add to the dev container. More info: https://containers.dev/features.
   // "features": {},
@@ -35,7 +35,13 @@
   // "postCreateCommand": "cat /etc/os-release",
 
   // Configure tool-specific properties.
-  // "customizations": {},
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "elixirLS.projectDir": "/app/server"
+      }
+    }
+  },
 
   // Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
   // "remoteUser": "devcontainer"

README.md

@@ -15,22 +15,23 @@ Please check out the [CONTRIBUTING](CONTRIBUTING.md) doc for tips on making a su
 
 ## Quick Start
 
-1. Load the Docker Configuration: `docker-compose up`
+1. Load the Docker Configuration: `docker compose up`
 2. Wait for containers to start up
 3. Navigate to [localhost:3000](http://localhost:3000) to view the website
 4. Navigate to [localhost:4000](http://localhost:4000) to access the API server
 
 > **Note**
-> This assumes you have installed [docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/).
+> This assumes you have installed [docker](https://docs.docker.com/engine/install/). If you're running Windows,
+> ensure [Docker Desktop](https://docs.docker.com/desktop/setup/install/windows-install/) is installed and running.
 
 ### Running in Docker
 
-Docker is the quickest way to get the project up and running, especially if you haven't already set up Erlang/Elixir/Node. The only requirement is that you have both [docker](https://docs.docker.com/v17.09/engine/installation/) and [docker-compose](https://docs.docker.com/compose/install/) installed on your machine.
+Docker is the quickest way to get the project up and running, especially if you haven't already set up Erlang/Elixir/Node. The only requirement is that you have [docker](https://docs.docker.com/engine/install/) installed on your machine.
 
-Once you clone the repository, you can just run docker-compose in the root directory:
+Once you clone the repository, you can just run `docker compose` in the root directory:
 
 ```shell
-docker-compose up
+docker compose up
 ```
 
 This will build an image locally with all the dependencies you need. It will also pull a pre-built image from [Docker Hub](https://hub.docker.com/r/orcasound/orcasite) for the database, automatically configure everything, and both the Phoenix and Next.js servers. The orcasite page will be accessible at [`http://localhost:3000`](http://localhost:3000) as soon as the `web` container finishes starting up.
@@ -39,19 +40,9 @@ This will build an image locally with all the dependencies you need. It will als
 
 The [quick start](#quick-start) setup is great for getting the project up and running, but if you want to do development, you'll want to be able to modify the source code without re-building an entire Docker image.
 
-### Setup options
+### Setup
 
-There are several options for how to set up your dev environment:
-
-- [VS Code with dev containers](#using-vs-code)
-- [Using docker-compose](#using-docker-compose-directly)
-- [Directly on your machine](#set-up-directly-on-machine)
-
-Once you have one of these up and running, see the [Getting everything running](#getting-everything-running) section for how to start the project.
-
-#### Using VS Code
-
-This project comes with a [devcontainer.json configuration](https://code.visualstudio.com/docs/devcontainers/containers) which can be used with VS Code. This takes care of all the `docker-compose` stuff in the background so you don't have to worry about it. When you open the project in VS Code, it should prompt you to start it in a dev container (assuming [you've installed docker and the dev containers extension](https://code.visualstudio.com/docs/devcontainers/containers#_installation)). Once the dev container starts, you can open a new terminal window in VS Code to run commands. See [the commands below](#getting-everything-running) for how to get everything started.
+This project comes with a [devcontainer.json configuration](https://code.visualstudio.com/docs/devcontainers/containers) which can be used with VS Code. This takes care of all the `docker compose` stuff in the background so you don't have to worry about it. When you open the project in VS Code, it should prompt you to start it in a dev container (assuming [you've installed docker and the dev containers extension](https://code.visualstudio.com/docs/devcontainers/containers#_installation)). Once the dev container starts, you can open a new terminal window in VS Code to run commands. See [the commands below](#getting-everything-running) for how to get everything started.
 
 > **Tip**
 > For a better VS Code experience, copy the example settings file:
@@ -62,64 +53,6 @@ This project comes with a [devcontainer.json configuration](https://code.visuals
 >
 > This provides recommended editor settings for this project. You can also see & install recommended extensions by opening the command palette (Cmd+Shift+P) and selecting "Extensions: Show Recommended Extensions".
 
-#### Using docker-compose directly
-
-If you prefer not to use VS Code dev containers, the easiest way to develop in docker is by starting up docker-compose manually (using the dev compose file):
-
-```shell
-docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d
-```
-
-> **Note**
-> You can also set the `COMPOSE_FILE` environment variable to avoid having to specify the compose files every time. This one-liner will do that for you no matter which subdirectory you're in:
->
-> ```shell
-> export COMPOSE_FILE=`git rev-parse --show-toplevel`/docker-compose.yml:`git rev-parse --show-toplevel`/docker-compose.dev.yml
-> ```
->
-> After setting COMPOSE_FILE, you can just run `docker-compose up -d` from anywhere in the project.
-
-Once you have the services started, you can start a session inside the `web` container:
-
-```shell
-docker-compose exec web bash
-```
-
-From here you can run the [commands below](#getting-everything-running) to get everything started.
-
-> **Note**
-> The `docker-compose` setup uses bind mounting for the source files, which means if you edit the source on your host file system, the changes will get picked up and live reloaded in your browser.
-
-#### Set up directly on machine
-
-If Docker doesn't suit your needs, you can follow these instructions to get everything running directly on your machine.
-
-##### Language
-
-You will need to install Erlang, Elixir, and Node.js. You can use a tool like [`asdf`](https://github.com/asdf-vm/asdf) to manage your language dependencies.
-
-Language-level dependencies can be found under `.tool-versions`.
-
-##### Database
-
-You will need to install Postgres and set up the `postgres` user with a password. The default connection details are:
-
-```text
-username: "postgres"
-password: "postgres"
-database: "orcasite_dev"
-hostname: "localhost"
-port: 5432
-```
-
-You can pass in custom values using env variables. Full details can be found in [`dev.exs`](config/dev.exs).
-
-Orcasite uses [PostGIS](http://postgis.net/) for location data inside of Postgres. To install on MacOS, run
-
-```shell
-brew install postgis
-```
-
 ### Getting everything running
 
 Once you have your environment setup via one of the options above, you can start the project. You'll need to run both the Phoenix server and the Next.js server.
@@ -157,7 +90,7 @@ Once everything finishes starting up, you'll be able to access the UI at [`http:
 The development environment automatically seeds the database with real data from the production server, including detections, audio images, and other records. This happens via background jobs that sync data every 1 minute.
 
 > **Note:**
-> Seeded resources will only work with feeds that match production (i.e. with the same `id` and `slug`). Clear your data with `mix ecto.drop` and re-initialize it with `mix ecto.setup` to get the latest data from the production servers.
+> Seeded resources will only work with feeds that match production (i.e., with the same `id` and `slug`). Clear your data with `mix ecto.drop` and re-initialize it with `mix ecto.setup` to get the latest data from the production servers.
 
 ### Seeding on setup