Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 3.24 KB

README.md

File metadata and controls

87 lines (63 loc) · 3.24 KB
Raw

GDG[x] Hub

Join the chat at https://gitter.im/gdg-x/hub

Build Status

The public instance of the GDG[x] Hub is hosted at [https://hub.gdgx.io]

Required tools

Install dependencies

Run npm install

Configure Environment

  1. Define the GOOGLE_SIMPLE_API_KEY: The API key for your project, available from the Cloud Console

    1. Create a new project then go to APIs & Auth->APIs, activate Google+ API.
    2. Go to APIs & Auth->Credentials. Add Credentials->API key->Browser key->Create (keep Any referrer allowed set).

  2. Define the GOOGLE_OAUTH_CLIENT_ID and GOOGLE_OAUTH_CLIENT_SECRET: The Client Id and secret for your project, available from the Cloud Console

    1. Go to APIs & Auth->Credentials. Add Credentials->API key->OAuth 2.0 client ID->Web Application->Create.

  3. Create a private .env file in the root of the project with the following contents:

    GOOGLE_SIMPLE_API_KEY=
GOOGLE_OAUTH_CLIENT_ID=
GOOGLE_OAUTH_CLIENT_SECRET=
SERVER_KEY_SECRET=
ANDROID_CLIENT_IDS=
MONGODB_DB_URL=
NODEJS_PORT=
NODEJS_IP=
SESSION_SECRET=

  4. Populate the .env file with the following variables that were provided to you:

    • GOOGLE_SIMPLE_API_KEY - Browser key from step 1
    • GOOGLE_OAUTH_CLIENT_ID - Web Application clientId from step 2
    • GOOGLE_OAUTH_CLIENT_SECRET - Web Application client secret from step 2
    • SERVER_KEY_SECRET - Only needed for testing Frisbee integration
    • ANDROID_CLIENT_IDS - Only needed for testing Frisbee integration. Needs to be a comma separated list
    • SESSION_SECRET - random 34 characters

Check Mongo Server

Run mongostart or mongod

Build and start the Hub

Run npm start

The distributable version will be placed in /dist. The debug web server has LiveReload.

Run Tests

Run npm test

Ingest data into your local Hub instance

See the wiki.

For GDG-X Core

History

###Contributors See list of contributors

Maintainer:

######GDG Apps, GDG[x] are not endorsed and/or supported by Google, the corporation.

License

© 2013-2017 GDG[x]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.