Reading Buddies

A simple SPA and REST API demo that aggregates the book reviews of multiple Goodreads users.

Cloned ES5 version from https://github.com/cgmartin/ReadingBuddies/tree/es5-version then converted the client code to TypeScript

Fixed issues related to breaking changes of updated gulp plugins (gulp-typescript and gulp-tslint).

  +-------------+
  |   Browser   |
  | Angular SPA |
  +------+------+
         |
 +-------+--------+   +-------------+
 | Express Server +---+ Redis Cache |
 +----------------+   +-------------+
         |
 +-------+--------+
 |  Goodreads API |
 +----------------+

Screenshots

Quick Start

Install and run the dependencies:

• Install Node.js
• Install and run Redis, or use the Redis Docker image: docker-compose up -d redis

Configure the application:

1. Request a Goodreads API Developer Key
2. Copy .env.example to .env
3. Modify .env with correct configuration values

Build and run the application:

1. Run npm install && bower install to install the app dependencies
2. Run npm run build to build the app JS/CSS bundles and static files folder (./build/)
3. Run npm start to start the http server
4. Open browser: http://localhost:8000

Build/refresh upon file changes:

1. Run npm run develop for development mode
2. Open browser: http://localhost:3000

License

MIT License Copyright © 2014 Christopher Martin