KiT

KiT - Helping you Keep in Touch.

This project is maintained by cooper-db

KiT - Keep In Touch

kit homepage

KiT is a native-like mobile app that reminds users to keep in touch with the people they most want to stay connected with. Upon signing up, users can import contacts from their phone or add users manually, inputting phone, email, relationship type (family, social or professional), notes, and the frequency with which they would like to be reminded to contact that person. The user opens the app each day to see a randomly generated contact (based on the preferred frequency of contact), and can either use the displayed phone/email information to get in touch, or send the contact a text message right from the home screen.

KiT's back-end API was engineered with Node/Express, utilizes KnexJS to make data requests to a PostgreSQL database, and is deployed on Heroku. The front-end was built with AngularJS and is wrapped with Ionic to enable native app functionality. User passwords are encrypted using Bcrypt, and user authentication is implemented using JWT web tokens.

[KiT's Tin-Can Phone Logo is credited to Meg Clingman, and is licensed under CC 3.0}(https://creativecommons.org/licenses/by/3.0/us/)

Examine, Play, Contribute

Feel free to fork and clone both the back-end and front-end repositories onto your local machine to see how KiT works or add additional features. Follow these instructions for local installation:

Install NPM dependencies

npm install

Install postgreSQL

brew install postgres

Create postgreSQL database named 'kit'

createdb kit

Run knex migrations to insert users and contacts tables into postgreSQL database

knex migrate:latest

Run knex seeds to insert records into users and contacts tables

knex seed:run

Add .env file and insert JWT secret

echo "SECRET:YOURSECRET" >> .env

Navigate to front-end repository and follow installation instructions:

https://github.com/cooper-db/kit-front-end