DRAFT Getting started

Getting Started

Dependencies

Running Paws Data Pipeline locally requires the following:

• Python v3.8 or higher (for backend development) - Download here.
• Node (for frontend development) - Download here.
• Docker - Download here.
• Git - Download here. To troubleshoot, reference the documentation here.

Suggested Extensions

• VSCode Docker extension - Download here.

Windows users, see our wiki for alternate directions from this point. ​

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) [Linux directions will be provided by Cris]
• Navigate to ../paws-data-pipeline/src
• Build the container (do this every time you make a change to the code): $ docker-compose build
• Run the container: $ docker-compose up

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

Note - Changes made to the image 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.