move setup instructions to separate file

pull/54/head
unknown 2019-04-01 17:16:41 -04:00
parent dcdde17cdd
commit 4962b736e1
1 changed files with 79 additions and 0 deletions

79
install.md Normal file
View File

@ -0,0 +1,79 @@
# Setup instructions
### 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
```