Merge pull request #4 from lindapaiste/minimal-version

readme

README.md

@@ -1,46 +1,32 @@
-# Getting Started with Create React App
-
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-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/).
+# Pet Search
+
+View the current version at [pets.lindapaiste.com](https://pets.lindapaiste.com/).
+
+This code was initially created for [savearescue.org](https://savearescue.org/adoptable-dogs-cats) to power their adoptable dog and cat search.
+
+---
+
+# Stack
+
+## Build
+ - Created with `Create React App`
+ - Hosted on `Vercel`
+ - `craco` used on top of `react-scripts` in order to support custom `.less` stylesheet variables
+
+## Packages
+ - UI with `antd`
+ - Carousels with `react-slick`
+ - Navigation with `react-router`
+ - API fetching with `axios`
+ - State management with `redux`
+   - Reducers and `thunk` actions created with `@reduxjs/toolkit`
+   - Connected to React with `react-redux`
+ - Text parsing with `he`
+ - Query string parsing with `qs`
+ - Basic utilities from `lodash`
+
+## External APIs
+ - All pet data from [`RescueGroups.org`](https://api.rescuegroups.org/v5/public/docs#start-here) v5 REST JSON API.
+   - Uses both `GET` and `POST` requests, where `POST` requests are used for passing complex search filters.
+ - Estimated user location from [`IPLocate.io`](https://www.iplocate.io/).
+   - I built a more accurate "use my current location" button with the web [`Geolocation API`](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API), but the client didn't like this and preferred for users to enter a zip code.