Tikr

Tikr is an application that blends the best of GitHub with the best of Linked in. This is a expansion of a project initially concieved by Mike Staub, Bryan Venable, Travis Chapman, and Richard VanBreemen. You can find the original repo on GitHub here.

Development Team

• Project Owner Tim Martin
• Scrum Master Scott Rice
• Build Master Kevin Primat
• UX Lead Yan Fan

Table of Contents

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

Usage

grunt serve

Browser window will open at localhost:9000 with the app.

Requirements

• Node
• Express
• Angular JS
• MongoDB
• Mongoose

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Roadmap

View the project roadmap here

LinkedIn & GitHub

When running on localhost, please set environment variables in your shell before running grunt so the application will work with LinkedIn and GitHub authentication.

Keys and secret keys for LinkedIn and GitHub are provided in a private message.

export LINKEDIN_API_KEY=linkedin-api-key
export LINKEDIN_SECRET_KEY=linkedin-secret-key
export GITHUB_ID=github-id
export GITHUB_SECRET=github-secret

To check whether variables have been set, please use shell command 'echo':

echo $LINKEDIN_API_KEY
echo $GITHUB_ID

and so on.

Contributing

See CONTRIBUTING.md for contribution guidelines.