Project Name

An api to handle authentication, database storage, friend requests, and location data for safer-apk.

Team

• Kyle Bradford
• Raphael Feliciano
• Tiffany Lin
• Dario Artega

Table of Contents

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

Usage

Method	Route	Params	Params Example	Request Data	Response Data
GET	/api/friends	N/A	N/A	N/A	JSON array of objects
GET	/api/friends/:id	id = friends user_id in SQL	id = 12	N/A	JSON object

Requirements

• Node 7.6.x
• Mysql 14.14

Development

1. run this command in terminal inside the db folder. This will set up the inital schema for mysql, assuming the user is root without a password.

mysql -u root < schema.sql

Installing Dependencies

From within the root directory:

npm install

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.