From 5436b43ea4f81cbc2fab966ff1276344897647fd Mon Sep 17 00:00:00 2001 From: "Collin M. Barrett" Date: Sun, 16 Feb 2020 17:35:40 -0600 Subject: [PATCH] rm dup-ed docs --- data/README.md | 29 ----------------------------- 1 file changed, 29 deletions(-) delete mode 100644 data/README.md diff --git a/data/README.md b/data/README.md deleted file mode 100644 index 21ff790fb..000000000 --- a/data/README.md +++ /dev/null @@ -1,29 +0,0 @@ -## Adding or Updating Lists - -To submit a new list or update data about an existing list, please submit a pull request to [data](https://github.com/collinbarrett/FilterLists/tree/master/data) in conjunction with the data model described [here](https://github.com/collinbarrett/FilterLists/wiki/Data-Model_sidebar). Alternatively, you can [open a new issue](https://github.com/collinbarrett/FilterLists/issues/new) providing information for all of the fields described in the [data model](https://github.com/collinbarrett/FilterLists/wiki/Data-Model_sidebar). - -## Building and Running Locally - -We have containerized FilterLists to make it as easy as possible for contributers to get the project up and running locally. - -### Up and Running - -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. Execute `docker-compose up`. -5. Visit the locally running version of FilterLists in a web browser at `http://localhost/`. - -### Testing changes to the data (.json files) - -#### Automated - -Execute: - -`docker-compose -f docker-compose.data.tests.yml down -v && docker-compose -f docker-compose.data.tests.yml build api && docker-compose -f docker-compose.data.tests.yml run api` - -#### Manual - -1. Execute `docker container ls` to find the `CONTAINER ID` of the `filterlists.api` container. -2. Execute `docker-compose up -d --build [CONTAINER ID]` replacing `[CONTAINER ID]` with the hash from step 1. -3. Verify your changes are properly reflected at `http://localhost/`.