/TripBook

Primary LanguageJavaScript

TripBook - ReadMe BADGE

Description

This is a web application that allows a user to view other users trip pictures, upload their own trip photos, and then search the other user's trips for travel ideas and recommendations.

Table of Contents

  1. Description.
  2. Installation.
  3. Technologies Used.
  4. Usage tips.
  5. License.
  6. Contribution Guidelines.
  7. Tests.
  8. Questions.
  9. Screenshot.

Heroku Link

URL: https://tripbook-voyageurs.herokuapp.com

Installation

This project's dependencies are contained in the package.json file contained in this repository. In order to install this app locally, Node and Mongo must be installed and accessible via the command line application on the local computer. Then run: (1) the command "npm install" in the local directory containing the utiltiy to install the dependencies, (2) the command "npm run seed" to seed the database, and (3) the commande "npm run develop" initialize the app, accessible at localhost:3000.

Alternatively, this app can be used via the deployment on Heroku without installation described above.

Technologies Used

  • Node.js, Express.js, GraphQL, MongoDB, Mongoose, JWT Authentication, Firebase, React, HTML, CSS, Heroku, and Clipboard.

Usage

Once the app is installed and run, the user can interact with the app via the web browser. Or the app is available via the Heroku deployment.

License

The MIT License (MIT) Copyright © 2021 Sara Kanga, Adam Maresch, Sean McElwain, and Grant Shell.

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.

Contribution Guidelines

See https://www.contributor-covenant.org/

Tests

No test are currently deployed for this project.

Questions

Contact information for Project Contributors

Sara Kanga

Adam Maresch

Sean McElwain

Grant Shell

For any question regarding this project, the preferred method of communication is via email.

Screenshot

Screenshot (247)