README.md

Curates.io

       

Revolutionary way to share collections of web content.

Team

• Product Owner: Jack Lu (JackTanRoo)
• Scrum Master: Andrew Brassington (jabbrass)
• Bo Liu (liubolightning)
• Daniel Streit (danielstreit)

Table of Contents

1. Usage
2. Requirements
3. Development
   1. Installing Dependencies
   2. Tasks
4. Team
5. Contributing

Usage

Setup the local database and run locally or deploy to an Azure instance and deployment script will run initialization tasks.

Requirements

• Mysql 2.4.3
• Angular 1.2.23
• Express 4.8.6
• Node 0.10.x

Development

Run the following command to start the local development environment:

grunt dev

Run the following command to run JsHint and Mocha-test suite:

grunt test

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

####Steps to setup a local MySql database:

1. Install MySQL; do not install with a password
2. Go to MySQL commandline using - 'mysql -u root'
3. From MySQL commandline create database called 'curates'
4. Check connection details in server/dbconfig.js is correct for your particular environment. ie. use environmental url, not localhost when deploying.
5. Run 'node server/dbconfig.js';
6. Now your db, table schema are set up! Refer to wiki for more detailed information.

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.