DRAFT Getting started

Getting Started

Dependencies

Running Paws Data Pipeline locally requires the following:

• (_review 1) Python - Download here.
• (_review 2) Node - Download here.
• Docker - Download here.

Windows users, see our wiki for alternate directions. ​

Download the source code

• Navigate to local destination directory.
• Clone the repo - $ git clone https://github.com/CodeForPhilly/paws-data-pipeline ​

Run the Docker container

• Run the Docker Desktop client locally (_review 4) (Mac) [Separate instructions for linux?]
• Navigate to .../paws-data-pipeline/src
• Build the container: $ docker-compose build
• Run the container: $ docker-compose up

The client should now be accessible at http://localhost:80.

Note - Changes made to the (_review 3) [resource files?] require removing volumes and rebuilding the container:

• $ docker-compose down -v
• $ docker-compose build
• $ docker-compose up ​

Running the frontend

• Navigate to .../paws-data-pipeline/src/client
• Install dependencies locally - $ npm install
• Run the client - $ npm run start

The client should now be accessible at http://localhost:3000. ​

Accessing the Docker API from the local client

The Docker container should expose an endpoint that the local client can access. You can test this in a browser while the container is running by navigating to http://localhost:5000/api/user/test. If you do not see "OK from User Test @ ...", see troubleshooting.