From e5cccdcf075b16e486d72a128f00df380261c9ea Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Sun, 31 Jan 2021 16:09:21 -0600 Subject: [PATCH] =?UTF-8?q?docs(readme):=20=F0=9F=93=B0=20basic=20building?= =?UTF-8?q?=20and=20running=20locally?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit closes #1998 --- .github/README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/README.md b/.github/README.md index 8c07eec8a..5c75ef81d 100644 --- a/.github/README.md +++ b/.github/README.md @@ -56,10 +56,16 @@ FilterLists does not maintain any of these lists. It serves only as a discovery We have containerized FilterLists to make it as easy as possible for contributers to get the project up and running locally. -1. Install Docker CE for your computer's operating system. [Docs](https://docs.docker.com/install/) -2. Clone the FilterLists git repository to your computer. [Docs](https://help.github.com/en/articles/cloning-a-repository) -3. Navigate to the root directory of your locally cloned FilterLists git repository in a command-line interface. -4. [TBD...](https://github.com/collinbarrett/FilterLists/issues/1998) +1. Install Docker CE. [Docs](https://docs.docker.com/install/) +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:
+`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:
+`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 # Acknowledgements