From f2d0eb401ce2c3e24db2b15f801b2f7b6fac4bda Mon Sep 17 00:00:00 2001 From: Arjun Patel Date: Mon, 31 Dec 2018 00:10:51 -0800 Subject: [PATCH] Update README.md --- README.md | 77 +++++++++++++------------------------------------------ 1 file changed, 18 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 9d9614c..174dc05 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,27 @@ -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +## Searching for Physicians on a Map (Client-side) -## Available Scripts +This entire repository is dedicated to the frontend portion of the web app. It is a React.js application, with one primary component (App.js), which includes most of the code for the single page app. -In the project directory, you can run: +### Design Choices +- First of all, decided to separate the frontend and backend, as that is the trend these days. Also, integrating the React app with Node.js application is less efficient as you may want different origins accessing the API such as a mobile app in the future. In addition, if you want to change infrastructure, it is easier to focus on each one without affecting the other. +- I have selected a package for the Google Maps API to abstract that component within React. +- My frontend focuses on simplicity so that the REST API can handle manipulation of the string, conversions, etc. +- Another API is the Geocoding API from Google in order to convert the given address of a physician into lattitude and longitude. This is then used fed into the Maps API to accurately pinpoint the location of the physician. -### `npm start` +### Note +- I decided to not make this application extremely modular with many components as there would be wasted efficiency making API calls in different components for such as small application. +- Please refer to the backend server-side documentation for information about the backend and database. + + +### Deployment: http://physiciansearch.com.s3-website-us-west-1.amazonaws.com/ (as posted above) +- Runs on AWS S3 instance through static website hosting. +- Can install s3cwd to smoothly deploy from a repository to s3 bucket (i.e. integrate with CI). + + +### `npm start` (local environment) Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits.
You will also see any lint errors in the console. - -### `npm test` - -Launches the test runner in the interactive watch mode.
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. - -### `npm run build` - -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `npm run eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### Code Splitting - -This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting - -### Analyzing the Bundle Size - -This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size - -### Making a Progressive Web App - -This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app - -### Advanced Configuration - -This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration - -### Deployment - -This section has moved here: https://facebook.github.io/create-react-app/docs/deployment - -### `npm run build` fails to minify - -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify