Skip to content

Latest commit

 

History

History
56 lines (28 loc) · 1.47 KB

README.md

File metadata and controls

56 lines (28 loc) · 1.47 KB

Crowdfunding Poller

This application will poll popular open source websites nightly. It builds a selection of currently active campaigns and allows basic perusal.

The bundled frontend will load one random active campaign from a crowdfunding site. Currently Kiva, and Donors Choose are polled.

Components

Backend

The backend server is written in Spring Boot. The process for polling the web services utilize Spring Batch.

Frontend

The frontend is written in React. Gatsby is used to host it.

Install

THis is a Java 8 application and should not be used with a later JDK.

Database

The application expects to connect to a Postgres database. For convenience a docker script is included to quickly stand up a new instance.

To run:

$ docker-compose -f ./docker/stack.yml up

Set up your connection details in src/main/java/resources/application.properties

Application

Build a new jar (if not provided with)

./gradlew build

Then run as a jar with Java 8. Later versions won't operate:

$ java -jar .//build/libs/crowdfund-0.0.1.jar

This will launch the application on port 8080. As a result of the first run the database tables will get created and populated.

Frontend

On running the jar the frontend should be available on localhost:8080 by default.

TODO

  1. Remove the Gatsby default spreadsheets
  2. Add schedules to poll campaigns nightly
  3. Get Gatsby to parse properly