Single Page React - responsive & accessible neighborhood map
An Udacity FEND Nanodegree project repository.
Just click here to run on GitHub Pages. Service worker is active on hosted version see note 5 in Lessons Learned Section.
After cloning the repository, you will need to install the project dependencies using node's npm as follows. In the command line terminal and from the directory of the cloned project enter:
npm installThen run this to test in your default browser served by a development server:
npm startJust create an issue here.
See also implementation notes in ...FENDp7/issues/1 Used my preferred DevFlow and labeling scheme.
| Area | Comments |
|---|---|
| 1. enable react | a. starting with create in a clean build per docsnpx create-react-app my-appwill generate package.json and readme.md so run first or take care when merging with DevFlow starting material |
| 2. gitignore | a. becoming a monster file, need to review cross platform needs against implementing my own style standards. Future TODO |
| 3. JSON API | a. Created my own for use on this project to create the map markers. See https://rudimusmaximus.github.io/dfwTips/ for readme and here for repo https://github.com/rudimusmaximus/dfwTips b. This repo is credited with link in footer. These tips are the source data for making map markers and geting the categories by which to filter. |
| 4. jsdoc | a. how does jsdoc differ when assigning arrow functions to declared variables as arrow functions are anonymous. b. no answer. opinion based approach. interesting, develop approach c. This eslint doc is a good way to go |
| 5. service workers | a. create react app comes with this! In development, we don't use. we build and host on github. In code, it's a single line edit. In src/index.js, opt into offline-first by switching serviceWorker.unregister() to serviceWorker.register() to turn on service worker. see docs |
| 6. svg | a. react uses https://www.w3.org/Graphics/SVG/ for it's rotating icon. Future TODO: research this space. |
| 7. Max watchers in ubuntu | a. limit issues with gitkraken is inotify issue in os, found item 1 and item 2 for resolution. bash cat /proc/sys/fs/inotify/maxUser_watches shows number active bash sudo sysctl fs.inotify.max_user_watches=99999 fixes and stays fixed for session in our crouton ubuntu when developing on chrome os |
| 8. npm | a. installed modules are now added as a dependency by default so the --save option is no longer needed. Other save options remain like --save-dev or --save-optional. see stackoverflow |
| 9. lists and keys | a. index approaches, see react doc, Medium recommendation for using 'shortid', recursion on children and keys (why), install shortid, b. Installed and used in this project c. Basically, Index as a key is an anti-pattern |
| 10. Hamburger menu (icons) | a. Used awesome fonts per this article And this app b. resizing font-size can help size the svg font also. Future TODO: research other solutions that flex the element height; I used vh or viewport height percent values that add up to 100 to ensure full page coverage since there is a menu title and a footer in addition to the map. This works in most cases but not perfect. Simulated landscape on mobile seemed not optimal, will review in testing. c. see also SVG JavaScript Core for advanced packages |
| 11. future enhancements | a. better sidebar styling including perhaps custom slectors and pick lists. see article for topic ideas |
| 12. collapsable nav bar | a. used udacity course material from review of patterns (off canvas pattern). articles and code samples include: udacity off canvas pattern code pen react example |
| 13. state values / where to best declare variables in React | a. React's setState is asynchronous inside event handlers and proved problematic for our use case. We preferred component variables for google api, and for the active filter selections. Testing for this was useful for learning React. Recommend learning Redux per React's own documentation. b. see React says maybe use Redux or MobX c. this post clarifies best where to declare variables in react |
| 14. React best practices | a. react component lifecycle 1, react component lifecycle 2 |
| 15. A11y | a. Accessible Maps On The Web], b. The A11Y Project, c. Future TODO: is there a way to tab imediately to info window after clicking a listing item that's in the tab order? Not sure if I want to if going modeless for better flow., d. Went with 0 value tab indices and some aria labels and roles including keypressevets for listing clicks. |
| 16. Build>Deploy>Host | a. “Surge VS GitHub Pages: How to deploy a create-react-app project” by Jake Wiesler, b. Went with GitHub Pages using npm pluggin gh-pages |
In adition to the articles listed in my above notes, I made use of the following walkthroughs and articles for insight, inspiration, and help.
Utility functions made use of functions from the following and are credited in Utilities.js :
From the course Project Overview, we create an app that fulfills the Project Rubric See also, #1 ...FENDp7/issues/1 for checklist.
In this application, the main page displays a map of at least 5 places. The app should have a way to list items that are marked on the map. Ability to filter and to provide additional information as indicated in the rubric.
Task: Create a React app that lets us interact with a set of filterable places and information from mulitple APIs.
About State: Because we are using multiple APIs, let's use an array of promises for getting our information (maybe). See also, Thinking in React Guide See notes in lessons learned especially number 13.
React Lot's of lessons learned and varying approaches to React. Key stubling blocks were:
see instructions in course. During early dev, used a working list of to do items built into the code; then, moved to checklisted issues.
Made use of GitKraken Glo board to access simple 'submit' checklist (see issue 1). Note, these are accessible from web, mobile iOs, and inside atom editor as well.
This project was bootstrapped with Create React App.
In the project directory, you can run:
npm startRuns the app in the development mode.
Open 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 testLaunches the test runner in the interactive watch mode.
See the section about running tests for more information.
npm run buildBuilds 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 for more information.
npm run ejectNote: 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.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.