robertaird / pet-detective

Pet-Detective

The app that helps the hunt for lost pets!

Team

Copypasta

Product Owner: Tourne Torres Scrum Master: Daniel Weill Development Team Members: Tourne Torres, Taijon Robinson, Daniel Weill

Some usage instructions

Requirements

Node 6.10.2
MySQL 2.13.0
Deployed with DigitalOcean

Place these keys in a file called map.config.js inside of your client folder window.GEOCODE_API_KEY = 'YOUR GEOCODE API KEY';

window.PLACES_API_KEY = 'YOUR PLACES API KEY';

Create a .env file in your root directory to store port and database variables. Localhost will suffice for db in most cases

You will need a database called petdetective, created in a mysql session. Once used, create a table called petpost with the following command:

create table petpost (id integer not null auto_increment, lostOrFound varchar(20), type varchar(20) , styles varchar(200), address varchar(140), message varchar(140), date varchar(140), latlong varchar(140), user varchar(75), petPic varchar(220), primary key (id), userpic varchar(220));

Create a users table with the following:

create table users ( email varchar(75) NOT NULL UNIQUE, picture varchar(220), first_name varchar(25), last_name varchar(25));

And create a comments table with the following

create table comments (postId varchar(20) NOT NULL, name varchar(20) NOT NULL, message varchar(300), time varchar(75), senderEmail varchar(75) NOT NULL);

If you plan on using the email feature, you'll need to include a

IP //server's ip PORT //server's port EMAIL_USER //websites email EMAIL_PASS //websites password

in your env file

The server is set to use smpt and ports for google emails. if you want to change that you'll need to change the host and port in the server.js file.

Installing Dependencies

From within the root directory:

Run this command: npm install

It's that simple!

Tasks

To start the app run: npm start

Contributing

See CONTRIBUTING.md for contribution guidelines.