You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@taverna.apache.org by al...@apache.org on 2015/08/24 13:41:40 UTC
[14/50] [abbrv] incubator-taverna-databundle-viewer git commit:
Update README with new setup instructions. Create .env.example file and add
.env file to .gitignore
Update README with new setup instructions. Create .env.example file and add .env file to .gitignore
Project: http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/commit/c7414376
Tree: http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/tree/c7414376
Diff: http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/diff/c7414376
Branch: refs/heads/master
Commit: c7414376f29e43a8c16a83dd9cbe08ef749db198
Parents: 3fd1d6a
Author: Denis Karyakin <sa...@gmail.com>
Authored: Fri Aug 14 16:45:09 2015 +0300
Committer: Denis Karyakin <sa...@gmail.com>
Committed: Fri Aug 14 16:45:09 2015 +0300
----------------------------------------------------------------------
.env.example | 9 +++++++++
.gitignore | 1 +
README.md | 44 ++++++++++++++++++++++++++++++++++++--------
3 files changed, 46 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/blob/c7414376/.env.example
----------------------------------------------------------------------
diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..b1b5f31
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,9 @@
+FACEBOOK_CLIENT_ID=
+FACEBOOK_CLIENT_SECRET=
+GOOGLE_CLIENT_ID=
+GOOGLE_CLIENT_SECRET=
+S3_KEY=
+S3_SECRET=
+S3_REGION=
+S3_ASSET_URL=
+S3_BUCKET_NAME=
http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/blob/c7414376/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index aac0167..7c15a7d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -14,3 +14,4 @@
database.yml
public/uploads
vendor/assets/bower_components
+.env
http://git-wip-us.apache.org/repos/asf/incubator-taverna-databundle-viewer/blob/c7414376/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 1e295aa..0dc000a 100644
--- a/README.md
+++ b/README.md
@@ -70,32 +70,60 @@ before accepting a larger contribution.
# Building and install requirements
-1. Install Ruby 2.2.1. With using rvm - `rvm install 2.2.1`
-2. Run `bin/setup` to install dependencies, create and set up database. By default used PostgreSQL
-3. Run server with command `rails s`
+**Requirements**
-For using omniauth you need set up environmental variables FACEBOOK_CLIENT_ID, FACEBOOK_CLIENT_SECRET, GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET.
+* [rvm](https://rvm.io/rvm/install)
+* ruby, installed with rvm (`rvm install 2.2.1`)
+* [node](http://nodejs.org) ([on github](https://github.com/joyent/node))
+* [bower](https://github.com/bower/bower) (>= 0.10.0) installed with npm
-For Google omniauth:
+**Set up**
+
+1. Run `bin/setup` to install dependencies, create and set up database. By default used PostgreSQL
+2. Run `rake bower:install` to install front-end assets
+
+**Set up omniauth**
+
+Google omniauth:
1. Visit [Console google](https://console.developers.google.com/). Click by link `APIs & auth` -> `Credentials` -> `Create new Client ID`
2. Set Redirect URIs as http://yoursite.com/users/auth/google_oauth2/callback
3. Enable Google+ API. Click by link `APIs & auth` -> `Google+ API` -> `Enable API`
+4. Set up environmental variables GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET
-For Facebook omniauth:
+Facebook omniauth:
1. Visit [Developers Facebook](https://developers.facebook.com/)
2. Click by `My Apps` -> `Add a New App`
3. Visit `Settings` -> `Advanced`. Fill in field `Valid OAuth redirect URIs` with http://yoursite.com/users/auth/facebook/callback
+4. Set up environmental variables FACEBOOK_CLIENT_ID, FACEBOOK_CLIENT_SECRET
+**Set up the AWS S3 for storage files in production environment**
-_TODO_
+1. Visit [AWS Console](https://aws.amazon.com/)
+2. Open the Amazon S3 console.
+3. Click Create Bucket.
+4. In the Create a Bucket dialog box enter a name and select a region.
+5. Click on the name of your account (it is located in the top right corner of the console). Then, in the expanded drop-down list, select Security Credentials.
+6. Click the Get Started with IAM Users button.
+7. Click the Create New Users
+8. Enter User Name(s) and click the Create
+9. Click the Download Credentials
+10. Set up environmental variables S3_KEY, S3_SECRET, S3_REGION, S3_ASSET_URL, S3_BUCKET_NAME
-* ...
+**Ways to set up environmental variables**
+
+1. Set Unix Environment Variables
+2. Use a local .env file. Template you can find in .env.example file
+3. Set environmental variables as parameters to command `rails s`
+
+Don't forget: Keeping Environment Variables Private
# Usage
+Run server with command `rails s`
+
_TODO_
* ...