Skip to content

Project for Epicodus focusing on API's using JavaScript. This application will use the BetterDoctor API to help users find doctors in their area who can treat their medical issue.

Notifications You must be signed in to change notification settings

ryanardo/better-doctor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project for Epicodus focusing on API's using JavaScript. This application will use the BetterDoctor API to help users find doctors in their area who can treat their medical issue.

By Ryan G Ferris

DESCRIPTION

  • A user should be able to enter a medical issue to receive a list of doctors in the Portland area that fit the search query.
  • A user should be able to to enter a name to receive a list of doctors in the Portland area that fit the search query.
  • If the query response includes any doctors, the following information should be included about each doctor: first name, last name, address, phone number, website and whether or not the doctor is accepting new patients (the API provides this data).
  • If the API call results in an error (any message not a 200 OK), the application should return a notification that states what the error is.
  • If the query response doesn't include any doctors (for instance, if no doctors meet the search criteria), the application should return a notification that states that no doctors meet the criteria. (This is not an error so it should be handled separately from any errors.)

SETUP/INSTALLATION REQUIREMENTS

  • Download and install an up to date web browser
  • Click on the following link to use the Better Doctor

API SETUP

  • Go to the BetterDoctor website, and get your own API Key.
  • In the root directory, create a .env file.
  • Copy the code below into your .env file; and replace the API_KEY with the user_key provided by the BeterDoctor 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) 2017 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.

About

Project for Epicodus focusing on API's using JavaScript. This application will use the BetterDoctor API to help users find doctors in their area who can treat their medical issue.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published