/doctor-api

Primary LanguageJavaScript

Doctor Lookup

Epicodus independent project week 6:

14 February 2020

By Zakkrey Short

Description

This project is a webpage that allows a user to input an ailment or doctor, and receive back information about doctors that fit your search query.

Specifications:

Specification Example Input Example Output
User enters an ailment Sore Throat Return: List of doctors in Portland Metro
User enters a doctor name Allen Return: List of doctors with 'Allen' in name.
User enters a state/city or-portland Return: List of doctors in Portland, Or
User enters an ailment that has no doctors around Flu Return: No results found
If API call has error 400 Return: Error Message

Setup/Installation Requirements

  • First, clone this repository to your desktop by navigating to the desktop in the Terminal (entering "cd desktop" in the Terminal) and then entering "git clone" followed by the url to this repository.
  • Once the project directory is cloned to your desktop, navigate to the directory in the terminal by entering "cd" followed by the name of this repository in the Terminal.
  • Confirm that you have navigated to the project directory by entering "pwd" in the Terminal.
  • Once you have navigated to the directory in the terminal, open the contents of the directory in a text editor or IDE of your choice (e.g., to open the contents of the directory in Visual Studio Code, enter the command "code ." in the Terminal).
  • Open index.html in a browser of your choice (e.g., Google Chrome).

API Key Access

  • Visit the BetterDoctor API site and click “Get a free API key”.

  • Fill out the form.

  • Your API key should be listed on the front page (ex: “a2c356ibgh44…..”) or under My Account > Applications.

  • Documentation for the BetterDoctor API used can be found here: https://developer.betterdoctor.com/documentation15

Bugs

No known bugs at this time. Properly returns information from both forms in one place.

Technologies Used

Git, HTML, CSS, JavaScript, jQuery, Bootstrap, Jest, Node, Postman, Webpack, BetterDoctor API

License

This webpage is licensed under the MIT license.

Copyright (c) 2020 Zakkrey Short