Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 3.75 KB

README.md

File metadata and controls

74 lines (55 loc) · 3.75 KB
Raw

The Strain API

Project for Epicodus focusing on API's using JavaScript. This application will use the The Strain API to help users find Strains of Marijuana.

By Matthew Jackson and Ryan G Ferris

DESCRIPTION

  • This web app implements The Strain API, allowing users to search for Marijuana Strains and their corresponding details.
  • Also utilizes the Leafly website (not their API).
  • After searching for a Strain using the The Strain API a user can click a link that will take them to the Leafly URL end point for the particular Strain to find where (if possible) they can purchase it from.
    • This functionality is accomplished using a Regex function that creates the Leafly URL endpoint based on the name of the Strain.

SETUP/INSTALLATION REQUIREMENTS

  • Download and install an up to date web browser
  • Click on the following link to use the The Strain API.

API SETUP

  • Go to the The Strain API website, and get your own API Key.
  • In the root directory, create a file, and label it as the .env file.
  • Copy the code below into your .env file; and replace the API_KEY with the user_key provided by the The Strain API.
exports.apiKey = "API_KEY";

TERMINAL COMMANDS

Testing

CLI Command to execute the webpack script for testing.

npm run test

Development Server

CLI Command to execute the webpack script for starting the development server.

npm run dev

Production Build

CLI Command to execute the webpack script for building the production build of the project.

npm run prod

KNOWN BUGS

There are currently no known bugs or issues. Please message me if you run into any and I'll do my best to fix them as quickly as possible!

SUPPORT AND CONTACT DETAILS

Email me at [email protected] if you have any questions, comments, concerns, or just a general desire to chat with me! I look forward to hearing from you!

TECHNOLOGIES USED

  • Bootstrap
  • Chai
  • CSS
  • Git
  • GitHub
  • HTML
  • JavaScript
  • JSON
  • Postman
  • Mocha
  • Webpack

LICENSE

Copyright (c) 2018 Matthew Jackson and Ryan G Ferris

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.