https://github.com/jmxo/readingbuddies
SPA and REST API demo that aggregates the book reviews of multiple Goodreads users
https://github.com/jmxo/readingbuddies
angular gulp typescript
Last synced: about 2 months ago
JSON representation
SPA and REST API demo that aggregates the book reviews of multiple Goodreads users
- Host: GitHub
- URL: https://github.com/jmxo/readingbuddies
- Owner: jmxo
- License: mit
- Created: 2016-11-15T04:06:02.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-06T18:23:54.000Z (over 9 years ago)
- Last Synced: 2025-01-23T09:51:42.513Z (over 1 year ago)
- Topics: angular, gulp, typescript
- Language: JavaScript
- Homepage:
- Size: 490 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](https://nodejs.org/en/download/)
* Install and run [Redis](http://redis.io/topics/quickstart), or use the Redis [Docker](http://docs.docker.com/) image: `docker-compose up -d redis`
Configure the application:
1. Request a [Goodreads API Developer Key](https://www.goodreads.com/api/keys)
1. Copy `.env.example` to `.env`
1. Modify `.env` with correct configuration values
Build and run the application:
1. Run `npm install && bower install` to install the app dependencies
1. Run `npm run build` to build the app JS/CSS bundles and static files folder (`./build/`)
1. Run `npm start` to start the http server
1. Open browser:
Build/refresh upon file changes:
1. Run `npm run develop` for development mode
1. Open browser:
## License ##
[MIT License](http://cgm.mit-license.org/) Copyright © 2014 Christopher Martin