river-of-ebooks/README.md

76 lines
1.7 KiB
Markdown
Raw Normal View History

2019-03-13 15:48:17 +00:00
# River of Ebooks
2019-03-25 16:22:14 +00:00
https://github.com/EbookFoundation/river-of-ebooks
2018-10-16 01:45:37 +00:00
2019-03-13 15:48:17 +00:00
## About
The River of Ebooks serves as an easy-to-use ebook aggregator. Publishers can send metadata from new and updated ebooks through the River where it will be available for any downstream consumers to read, allowing for a more widely available ebook collection. This way, ebooks can be made available on all end user sites, instead of only the site they were published with.
2018-10-16 01:45:37 +00:00
2019-03-13 15:48:17 +00:00
-----
2018-10-16 01:45:37 +00:00
### Version info
This app was originally generated on Tue Oct 16 2018 01:21:31 GMT+0000 (UTC) using Sails v1.0.2.
<!-- Internally, Sails used [`sails-generate@1.15.28`](https://github.com/balderdashy/sails-generate/tree/v1.15.28/lib/core-generators/new). -->
2019-02-27 18:27:31 +00:00
### Setup
2019-03-13 15:48:17 +00:00
a [Sails v1](https://sailsjs.com) application
[![Build Status](https://travis-ci.org/miacona96/RoE-pipe.svg?branch=master)](https://travis-ci.org/miacona96/RoE-pipe)
2019-02-27 18:27:31 +00:00
#### Standalone
1. Standard npm install
```
2019-03-25 16:26:41 +00:00
git clone https://github.com/EbookFoundation/river-of-ebooks
cd river-of-ebooks
2019-02-27 18:27:31 +00:00
npm i
```
2. Configure environment variables in /etc/environemnt
2019-02-27 18:27:31 +00:00
```
PASSPORT_GOOGLE_ID
PASSPORT_GOOGLE_SECRET
PASSPORT_GITHUB_ID
PASSPORT_GITHUB_SECRET
DATABASE_CONNECTION
2019-02-27 18:27:31 +00:00
```
3. Run database migrations
2019-02-27 18:27:31 +00:00
```
npm run db:migrate
```
4. Start server
2019-02-27 18:27:31 +00:00
```
npm start
```
#### Elastic Beanstalk
1. Clone repo
```
git clone https://github.com/EbookFoundation/river-of-ebooks
cd river-of-ebooks
2019-02-27 18:27:31 +00:00
```
2. Deploy to environment
```
eb deploy environment_name
```
3. Configure environment variables on elastic beanstalk
2019-03-20 19:08:19 +00:00
```
PASSPORT_GOOGLE_ID
PASSPORT_GOOGLE_SECRET
PASSPORT_GITHUB_ID
PASSPORT_GITHUB_SECRET
DATABASE_CONNECTION
```
2019-03-20 19:09:46 +00:00
4. Run database migrations
```
npm run db:migrate
```
5. Start server
```
npm start
```