irl

irl is an ultra-local live feed of interesting events happening near you, today. Browse spots, create spots, share spots.

Team

• Product Owner: Josh Riesenbach
• Scrum Master: Michelle Thorsell
• Development Team Members: Jisoo Yoon, Calvin Le, Neil Murphy

Table of Contents

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

Usage

To install locally:

1. Fork and clone repo.
2. Download and install Java SDK 8.
3. Download and install the DynamoDB JAR.
4. Run DynamoDB to create a local database.
5. Install dependencies.
6. Run nodemon sesrver/server.js to start the server.
7. Visit localhost:8080.

Requirements

• Node 5.5.0 (higher versions may break test suite)
• React ^0.14.7
• Express ^4.13.4
• Gulp ^3.9.1
• Python 2.7.x

For Testing:

• Mocha ^2.4.5
• Chai ^3.5.0

Development

Installing Dependencies

From within the root directory:

sudo npm install -g bower
npm install
bower install

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.