From 115f001e8469b929065d6761f590624ef432ce7a Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Sun, 31 Jan 2021 16:34:18 -0600 Subject: [PATCH] =?UTF-8?q?docs(readme):=20=F0=9F=93=B0=E2=99=BB=20use=20c?= =?UTF-8?q?onsistent=20naming=20of=20services?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/README.md b/.github/README.md index 5c75ef81d..a779842ed 100644 --- a/.github/README.md +++ b/.github/README.md @@ -60,12 +60,12 @@ We have containerized FilterLists to make it as easy as possible for contributer 2. Install the current version of Node.js. [Docs](https://nodejs.org/en/download/current/) 3. Clone the FilterLists git repository to your computer. [Docs](https://help.github.com/en/articles/cloning-a-repository) 4. Navigate to the root directory of your locally cloned FilterLists git repository in a command-line interface. -5. Start the API services:
+5. Start the APIs:
`docker-compose -f docker-compose/docker-compose.yml -f docker-compose/docker-compose.override.yml up -d`
You can then view the API docs and execute API calls here: http://localhost:8080/api/ -6. Start the Directory web app:
+6. Start the Web app:
`npm i --cwd web && npm start --prefix web`
-You can then view the Directory web app calling your local instance of the Directory API here: http://localhost:3000 +You can then view the Web app calling your local instance of the Directory API here: http://localhost:3000 # Acknowledgements