p3tuh/Boundless-Avocado

GuacFriends

Meetup on the Fly

GuacFriends is the easiest way to form groups of common interest & invite your group to join you at any time. Get SMS invitations when others want to do the activity.

• You don't need to remember who told you they're interested.
• Everyone can manage their own membership to join and leave.
• No need to RSVP or create calendar events.
• You can control it with the web client, SMS, or email!

"An Avocado a day keeps the loneliness away."

Team

• Product Owner: David Ernst
• Scrum Master: Michael DeLucco
• Test Champion: Peter Kim

Table of Contents

1. Usage
2. Development
   1. Requirements
   2. Installing Dependencies
   3. Configuring API Keys
   4. Running the Server
   5. Roadmap
   6. Contributing

Usage

1. Create & join groups for your interests.
2. Invite others to join you.
3. Use GuacFriends to ping everyone in your group when you want to get together.

Development

Requirements

• Node.js

Installing Dependencies

From within the root directory:

npm install
sudo npm install -g bower nodemon
bower install

Configuring API Keys

You'll need API keys to connect to Twilio and Sendgrid. Send us a message for ours or sign up for their free trials. To configure the keys, run these commands from the terminal:

export TWILIO_ACCOUNT_SID=keyhere;
export TWILIO_AUTH_TOKEN=keyhere;
export SENDGRID_API_USER=keyhere;
export SENDGRID_API_KEY=keyhere;

Running the Server

From within the root directory:

nodemon

It should now be accessible at http://localhost:8080.

Roadmap

View our feature wishlist here.

Contributing

See CONTRIBUTING.md for contribution guidelines.