Whisker Meets

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

Whisker Meets Whisker is a web platform that connects dog owners based on location. Users are able to setup playdates and hangouts for their dogs and leave reviews and comments about interactions with various dogs in the neighborhood.

Built With

• JavaScript
• NodeJS
• MongoDB
• Express

Getting Started

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

Installation

1. Download or clone this repo

   $ git clone git@github.com:ellojess/whisker-meets-js.git

2. cd into the project folder and open it in your chosen text editor (or use code . to open it in Visual Studio Code

   $ cd whisker-meets-js
   
   $ docker-compose up

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 Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request using this template

Possible Contributions

• Add a new feature (ex: hangouts log, user profiles)
• Make the project cross platform
• New UI

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jessica Trinh - @ellojesss - jtjessicatrinh@gmail.com

Project Link: https://github.com/ellojess/whisker-meets-js

Acknowledgements

• Docker
• NodeJS
• MongoDB
• Express
• npm

Uptime monitored by FreshPing