search

appirio-tech / lc1-project

Core challenge engine for Serenity Project
MIT License
6 stars 8 forks source link

readme

topcoder Project SERENITY: a refresh of the topcoder challenge lifecycle

Major parts of this project are currently being developed on the MEAN.io framework but we have added support for PostgreSQL. Documentation for MEAN.io can be found in the [MEAN.io doc directory] (http://mean.io/#!/docs) as well as the results of our first challenge PEAN.io prototype - MEAN with PostgreSQL support which should help you set up your environment as well as standup a Heroku instance.

This core uses the following modules in addition to the mean.io framework to support PostgreSQL.

Quickstart

This should be supper simple to get up and running. Please only use this method in testing and when working on front end changes.

  1. Checkout out the code from the github repo git clone https://github.com/topcoderinc/serenity-core.git
  2. cd to serenity-core and run npm install the post install script will run bower and get all the bower modules
  3. Although the default env development comes pre-configured with connection url (Deadwood) for postgres you will still need postgres installed and in your path to create the bindings.
  4. run grunt defaults to development you can copy config/env/development.js to local.js and modify to connect to you local database. You should always do this when you start developing so the DEADWOOD (see below) schema is not disturbed
  5. Here is a list of dependencies that assume you have installed
    1. Node.js
    2. postgresSQL (for bindings in pg npm, and running local)
    3. mongodb (for running local)
    4. grunt (installed globally)
    5. bower (installed globally)
    6. mean-cli (installed globally if you want to use the scaffolding tool)

Deadwood

For your convenience we have pre-configured the development config files with actual live databases hosted via Heroku. We are collective referring to these two databases as Deadwood. This is the wild west so be careful. So you should be able to run npm install followed by grunt and see a live app with real data. Please keep in mind you still need PostgreSQL installed localy to run the app, since the npm install of pg will look for local pg bindings. The Deadwood databases are considered the wild west, and should be used at your own risk. If you are working on a challenge that does NOT alter the model (i.e. a UI challenge) you are welcome to use Deadwood. However if you are working on a challenge that needs to alter either database you should switch to local dbs.

Switching to a local database and creating schema

The NODE_ENV var defines which database you use. We have added config/env/local.js to the gitignore so if you create this file it wont be commited and you can secure you local db credentials. To switch to local do the following:

  1. copy config/env/development.js to config/env/local.js.
  2. edit this new file and add you db string for mongo and postgres.
  3. create the local postgres db
  4. run grunt dbmigrate
  5. from you shell run grunt local and start your app.

Database migrations

To help keep databases in sync, please refer to the instructions in docs/db-migrate.md

Any changes to the schema must have a migration file.