Project Oracle aims at a mash-up application which integrates together other applications such as Flowdock, Google spreadsheets and Pivotal Tracker.
-
Clone/download the project
-
Generate an SSL key and cert for yourself:
$ mkdir ssl $ cd ssl $ openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 1000 -
Configure the application using config file. The used configuration file is determined by NODE_ENV environment variable. The configuration file path pattern is config/config.[NODE_ENV].js. If NODE_ENV is not issued, the file is config/config.development.js.
Configuration file example:
var fs = require('fs');
module.exports = {
sslOptions: {
key: fs.readFileSync('./ssl/key.pem'),
cert: fs.readFileSync('./ssl/cert.pem')
},
dbOptions: {
options: {
host: '<database host>',
port: '<database port>',
database: '<database name>',
username: '<username>',
password: '<password>',
dialect: '<dialect>', // e.g. 'postgres'
protocol: '<protocol>', // e.g. 'postgres'
logging: false
},
// Make up a long secret string here
encryptKey: '<encryptkey>',
projects: [
{
name: "test",
applications: [
{id: "flowdock", organization: "<organization>", flow: "<flow>"},
{id: "pivotal", projectId: "<projectId>"},
{id: "googledocs", docs: [{name: "<name>", url: "<url>"}]}
],
// Pre-register users
users: ["[email protected]"]
}
],
force: true
},
// Make up a long secret string here
sessionSecret: '<SessionSecret>',
debug: true,
auth: {
// Get these by registering your new application with
// Google and Flowdock
googleAuth: {
clientID: '<ClientID>',
clientSecret: '<ClientSecret>'
},
flowdockAuth: {
clientID: '<ClientID>',
clientSecret: '<ClientSecret>'
}
}
}
-
To install and run locally, issue commands
npm install npm start
Alternatively you can deploy the application elsewhere.
Set NODE_ENV environment variable to "heroku" and configure the rest of the environment variables to deploy to Heroku.
If you want to use Docker, install Docker and Fig and run fig up. Remember to generate your SSL key without a passphrase, with e.g.
openssl req -nodes -new -x509 -keyout key.pem -out cert.pem