/web-doc

Project using API calls to cross symptoms / doctor names with BetterDoctor's database.

Primary LanguageJavaScript

Web Doc

A program using API calls to query a medical database to recommend doctors based on symptoms, at any inputted city

By Travis Toal

Installation / Usage

  • Clone this repository to your machine, and run 'npm install' to download the dependencies.
  • Run 'npm run start' to build the project on a local server.
  • Replace 'process.env.exports.apiKey' with your own API key to make the program functional

Description

  • Web Doc uses the Better Doctor API to take a user's input, either a symptom or a doctor's name, and returns a list of doctors that fit that specialty or name. It also takes in a user's desired city and uses MapQuest's API to find the coordinates, to plug into the Better Doctor API.

Planning

  1. Dependencies
  • babel-core, loader, and preset-es2015: compiles JS for different browsers
  • clean-webpack-plugin: clears dist folder
  • css-loader, style-loader, sass-loader, node-sass: dependencies for styles
  • eslint, eslint-loader: linter for JS
  • file-loader: loads images
  • html-webpack-plugin: dependency for loading html file
  • uglifyjs-webpack-plugin: minifying dependency
  • webpack, webpack-cli, webpack-dev-server: bundling dependencies
  • dotenv-webpack: makes api key available within files
  1. Configuration
  • Set up project as npm/webpack-bundled, behavior-driven, logic-separated directory
  1. Specs
Spec Input Output
Program returns a list of doctors based on the inputted symptoms Sore throat Dr. Example McFake, Doctor of throats. Etc...
Program returns a list of doctors based on the inputted name Exampleson Dr. Leonard Exampleson, Hypothetical Doctor Extraordinaire. Etc...
Program returns all known information about the returned doctors Doctor Firstname Lastname, Address Phone Website, Accepting new patients?
Program returns an error message is the promise doesn't return a 200 OK message Return 404 error Data not found
Program returns a message if no doctors match your criteria Dr. Fancypants Scrufflestone Your search did not match any results
Program allows the user to input their preferred city Phoenix,AZ Doctors in Phoenix
  1. UX/UI
  • Include and modify html/Sass once specs are completed for .js files

Technologies Used

  • Node Package Manager

  • Sass

  • jQuery

  • All of the dependencies listed in the planning section

Known Bugs

  • No known bugs as of 3/22/19

Support and Contact Details

WARNING - mailto link:

Email me for any questions

Non-mailto information:

Email: travisty12@gmail.com

View my work on GitHub

License

  • This software is licensed under the MIT license

Copyright (c) 2019 Travis Toal