/bird-brains

Online community for bird watchers which gamifies the hobby by awarding points for each bird sighting.

Primary LanguageJavaScriptMIT LicenseMIT

Bird Brains

Description

🔍 Bird Brains is an application for disrupting the bird watching industry. This application allows users to log bird sightings, receive a score based on their sighting, view other sightings, view high scores, and more! This is a full-stack node express application with server-side rendering generated via handlebars. Our application follows the model-view-controller design pattern.

Technologies

  • Initial Design: Figma, Coolors
  • Front End: Materialize, jQuery, Cloudinary, Slick,
  • Back End: Node, Express, Sequelize, Handlebars, ES Lint, Moment
  • Database: MySQL, JawsDB
  • DevOps: Heroku

Table of Contents


Installation

💾 From GitHub, fork the repo and upload all contents to the deployed server. The server must have Node.js installed. Once forked, run npm i from the root directory to install required dependencies.

Modify the /config/connection.js file to connect to your MySQL server. Create the database bird_brains in your MySQL server, and insert seed data located in the db repo.


Usage

💻 Visit our Heroku site and start logging bird sightings!

screenshot of Bird Brains homepage

demo gif of Bird Brains app


License

This application is covered under MIT License

License Text

Copyright (c) 2021  Adrian Ash, Jacquie Gutierrez, Pete Kriengsiri, Tony Schwebach

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
      
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
      
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


Contributing

Please contact the authors of this application to request access to the repository as a contributor/

👪 Adrian Ash, Jacquie Gutierrez, Pete Kriengsiri, and Tony Schwebach


Badges

GitHub issues

GitHub forks

GitHub license

GitHub stars


Questions

✋ Contact us on Github!

Find us on GitHub: Bird Brains

Our Team

👪 Adrian Ash, Jacquie Gutierrez, Pete Kriengsiri, and Tony Schwebach


References