From f0561f6f2a8e8f52b829881c464af454ac4efe5a Mon Sep 17 00:00:00 2001 From: Dave Thaler Date: Thu, 13 Jun 2024 23:47:05 -0700 Subject: [PATCH] Fix nits in README.md (#487) * Fix typos in README.md "setup" is a noun, whereas "set up" is a verb. Also, per Chicago Manual of Style, "e.g." should always be followed by a comma. Signed-off-by: Dave Thaler * Improve quick start section --------- Signed-off-by: Dave Thaler Co-authored-by: Paul Cretu --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index f07519bf..99a059ea 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ This repo specifies the web backend and frontend for the [Orcasound app](http:// Please check out the [CONTRIBUTING](CONTRIBUTING.md) doc for tips on making a successful contribution, as well as learning resources! -## Quick Start (e.g. at hackathons): +## Quick Start: -- Load the Docker Configuration: `docker-compose up` -- Wait for container to start up -- Navigate to [localhost:3000](http://localhost:3000) to view the website -- Navigate to [localhost:4000](http://localhost:4000) to access the API server +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/). @@ -36,11 +36,11 @@ This will build an image locally with all the dependencies you need. It will als ## Developing -The default Docker configuration 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. +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 -There are several options for how to setup your dev environment: +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) @@ -92,7 +92,7 @@ Language-level dependencies can be found under `.tool-versions`. ##### Database -You will need to install Postgres and setup the `postgres` user with a password. The default connection details are: +You will need to install Postgres and set up the `postgres` user with a password. The default connection details are: ``` username: "postgres"