move setup instructions to separate file
parent
4962b736e1
commit
2d99c88d26
79
README.md
79
README.md
|
@ -4,82 +4,3 @@ https://github.com/EbookFoundation/river-of-ebooks
|
||||||
## About
|
## 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.
|
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.
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
### 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). -->
|
|
||||||
|
|
||||||
### Setup
|
|
||||||
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)
|
|
||||||
|
|
||||||
#### Standalone
|
|
||||||
|
|
||||||
1. Standard npm install
|
|
||||||
```
|
|
||||||
git clone https://github.com/EbookFoundation/river-of-ebooks
|
|
||||||
cd river-of-ebooks
|
|
||||||
npm i
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Configure environment variables in /etc/environemnt
|
|
||||||
```
|
|
||||||
PASSPORT_GOOGLE_ID
|
|
||||||
PASSPORT_GOOGLE_SECRET
|
|
||||||
PASSPORT_GITHUB_ID
|
|
||||||
PASSPORT_GITHUB_SECRET
|
|
||||||
DATABASE_CONNECTION
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Run database migrations
|
|
||||||
```
|
|
||||||
npm run db:migrate
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Build public content
|
|
||||||
```
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
5. Start server
|
|
||||||
```
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Elastic Beanstalk
|
|
||||||
|
|
||||||
1. Clone repo
|
|
||||||
```
|
|
||||||
git clone https://github.com/EbookFoundation/river-of-ebooks
|
|
||||||
cd river-of-ebooks
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Deploy to environment
|
|
||||||
```
|
|
||||||
eb deploy environment_name
|
|
||||||
```
|
|
||||||
|
|
||||||
3. Configure environment variables on elastic beanstalk
|
|
||||||
```
|
|
||||||
PASSPORT_GOOGLE_ID
|
|
||||||
PASSPORT_GOOGLE_SECRET
|
|
||||||
PASSPORT_GITHUB_ID
|
|
||||||
PASSPORT_GITHUB_SECRET
|
|
||||||
DATABASE_CONNECTION
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Run database migrations
|
|
||||||
```
|
|
||||||
npm run db:migrate
|
|
||||||
```
|
|
||||||
|
|
||||||
5. Build public content
|
|
||||||
```
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
6. Start server
|
|
||||||
```
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
Loading…
Reference in New Issue