/otter

Primary LanguageJavaScript

Contributors Languages Forks Issues


Logo

Otter

The app made for you and your significant otter!
Live Demo | Report Bug or Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. Contact
  6. Acknowledgements

About The Project

Otter is a relationship enhancement app which was designed to improve today's dating experience. Whether your relationship is in the beginning stages, or thriving along, Otter can assist the growth of any couple. By considering and assesing the need's of ourselves and our significant Otter (see what we did there?), Otter emphasizes the focus on relationship communication by incorporating a Love language survey, a conversational questionaire and user friendly interface. Otter's Pebble system awards merit to encourage consistent use of the app as well as a scheduling feature to ensure optimal use of couple time. The Otter team thanks all developers and users for checking out our works and encourage critiques for future enhancements.

Key Focuses

  • Calendar - Otter's calendar feature allows couples to keep each other up-to-date on upcoming life changes and provides a non-intrusive reminder of important milestones. Not really enthusiac about a new job interview? Otter's calendar features a "mood" setting to express any nervousness, or anticipated excitement.
  • Love Language Game - How do you express love? How does your Otter feel loved? Take the Otter Love Language quiz to learn more about the love patterns in your realtionship!
  • Otter Question Game - Running out of topics? Don't worry we've got you covered with 20 thought provoking questions!

Random Dad Joke: I love you... Like no Otter!

Built With

  • React Native | React JS
  • JavaScript | Firebase

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Get a free API Key at API Website

Install npm

npm install npm@latest -g

Installation

Clone the Repository

git clone https://github.com/alynapchuk/otter.git

Install NPM packages

npm install

Enter your API in config.js

const API_KEY = 'ENTER YOUR API';

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Branch (git checkout -b yourbranch/Contribution)
  3. Commit your Changes (git commit -m 'added amazing feature')
  4. Push to the Branch (git push origin yourbranch/Contribution)
  5. Open a Pull Request

Contact

Alyna Palamarchuk - Portfolio - LinkedIn - alynapchuk@gmail.com
Otis Wilcox - Portfolio - LinkedIn - otiswilcox@gmail.com
Erin Harper -
Joshua Simon - Portfolio -LinkedIn - itt.simonj@gmail.com

Acknowledgements

GitHub Emoji Cheat Sheet - Img Shields - Choose an Open Source License - GitHub Pages - Animate.css - Loaders.css - Slick Carousel - Smooth Scroll - Sticky Kit - JVectorMap - Font Awesome

[product-screenshot]: