├── .github └── pull_request_template.md ├── .gitignore ├── README.md ├── package.json ├── public ├── favicon.ico ├── index.html ├── logo192.png ├── logo512.png ├── manifest.json └── robots.txt ├── src ├── App.css ├── App.js ├── App.test.js ├── index.css ├── index.js ├── logo.svg ├── serviceWorker.js └── setupTests.js └── yarn.lock /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | # PR Description 2 | 3 | ✨ This PR fixes the issue number: 4 | 5 | ✨ Here's the summary of my changes and my motivation behind them: 6 | 7 | - 8 | - 9 | - 10 | 11 | ✨ This PR changes or adds functionality which will require updating the documentation: YES/NO (leave what's relevant) 12 | 13 | 14 | # Self-check: 15 | 16 | Please check all that apply: 17 | 18 | - [ ] My code follows the style guidelines of this project 19 | - [ ] I have reviewed my code, refactored it to the best of my abilities and deleted all unnecessary code 20 | - [ ] I have commented my code, particularly in hard-to-understand areas; my comments are concise 21 | - [ ] I have made corresponding changes to the documentation 22 | - [ ] My changes generate no new warnings and no new bugs 23 | 24 | # Contributors list 25 | Would you like to be featured on the [contributors list](https://github.com/sylwiavargas/The-Code-Bending-Dictionary-React#contributors)? If so, please tell us: 26 | - what name you'd like to be shown there? 27 | - we usually link github profile pic -- is that ok? If not, provide another url: 28 | - we usually link your github profile but if you have a portfolio page, provide a link: 29 | 30 | ✨ ✨ ✨ Thank you for contributing to the Code Bending Dictionary ✨ ✨ ✨ 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # dependencies 4 | /node_modules 5 | /.pnp 6 | .pnp.js 7 | 8 | # testing 9 | /coverage 10 | 11 | # production 12 | /build 13 | 14 | # misc 15 | .DS_Store 16 | .env.local 17 | .env.development.local 18 | .env.test.local 19 | .env.production.local 20 | 21 | npm-debug.log* 22 | yarn-debug.log* 23 | yarn-error.log* 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # The Code-Bending Dictionary - React Frontend 2 | --- 3 | 4 | A volunteer dictionary of Ruby, Rails, JavaScript, React and Redux terms for the new code benders. 5 | 6 | The dictionary was an idea of **The Code Benders Cohort** of Flatiron School's Immersive Software Engineering Program, and was developed initially as a part of Ruby and Ruby on Rails lectures. 7 | 8 | --- 9 | 10 | ## Table of contents 11 | - [Getting Started](#getting-started) 12 | - [Node Installation on OS X](#node-installation-on-os-x) 13 | - [Node Installation on Linux](#node-installation-on-linux) 14 | - [Node Installation on Windows](#node-installation-on-windows) 15 | - [Installation](#installation) 16 | - [Start and Watch](#start-and-watch) 17 | - [Component hierarchy](#component-hierarchy) 18 | - [Languages and tools](#languages-and-tools) 19 | - [Frontend framework: React](#react) 20 | - [Localization: i18next](#i18next) 21 | - [Analytics: react-ga ](#react-ga) 22 | - [Contributing](#contributing) 23 | - [Known Issues](#known-issues) 24 | - [Core Team](#core-team) 25 | - [Contributors](#contributors) 26 | - [License](#license) 27 | 28 | --- 29 | 30 | ## Getting Started 31 | For development, you will only need [Node.js](http://nodejs.org/) installed on your environement. 32 | 33 | #### Node installation on OS X 34 | 35 | You will need to use a Terminal. On OS X, you can find the default terminal in 36 | `/Applications/Utilities/Terminal.app`. 37 | 38 | Please install [Homebrew](http://brew.sh/) if it's not already done with the following command. 39 | 40 | $ ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)" 41 | 42 | If everything when fine, you should run 43 | 44 | brew install node 45 | 46 | #### Node installation on Linux 47 | 48 | sudo apt-get install python-software-properties 49 | sudo add-apt-repository ppa:chris-lea/node.js 50 | sudo apt-get update 51 | sudo apt-get install nodejs 52 | 53 | #### Node installation on Windows 54 | 55 | Just go on [official Node.js website](http://nodejs.org/) & grab the installer. 56 | Also, be sure to have `git` available in your PATH, `npm` might need it. 57 | 58 | 59 | ## Installation 60 | 61 | ``` 62 | $ git clone git@github.com:sylwiavargas/The-Code-Bending-Dictionary-React.git 63 | $ cd The-Code-Bending-Dictionary-React 64 | $ npm install 65 | ``` 66 | 67 | ## Start and Watch 68 | 69 | ``` 70 | $ npm start 71 | ``` 72 | --- 73 | 74 | ## Component Hierarchy 75 | ![Component hierarchy graph](component-hierarchy.png) 76 | 77 | --- 78 | ## Languages and Tools 79 | 80 | ### React 81 | 82 | - [Create React App](https://github.com/facebook/create-react-app) 83 | 84 | ### react-ga 85 | 86 | - [React-ga](https://github.com/react-ga/react-ga) 87 | 88 | --- 89 | 90 | ## Contributing 91 | Please read our [wiki on contributing]( https://github.com/sylwiavargas/The-Code-Bending-Dictionary-React/wiki/3.-Contributing-to-the-Code-Bending-Dictionary) and [code of conduct](https://github.com/sylwiavargas/The-Code-Bending-Dictionary-React/wiki/2.-Code-of-Conduct). 92 | 93 | For major changes, please open an issue first to discuss what you would like to change. 94 | 95 | ### Known issues 96 | Visit [issues](https://github.com/sylwiavargas/The-Code-Bending-Dictionary-React/issues) section. 97 | 98 | ### Core Team 99 | 100 | 101 | 110 | 111 | 119 | 120 | 128 | 129 | 137 | 138 |
102 |
Sylwia Vargas

103 | 💻 104 | 🐛 105 | 🛠 106 | 🚇 107 | 📖 108 | 💡 109 |
112 |
Eric Kim

113 | 💻 114 | 🐛 115 | 🛠 116 | 🚇 117 | 💡 118 |
121 |
Annie Zheng

122 | 💻 123 | 🐛 124 | 🛠 125 | 🚇 126 | 💡 127 |
130 |
Isabel K. Lee

131 | 💻 132 | 🐛 133 | 🛠 134 | 🚇 135 | 💡 136 |
139 | 140 | 141 | ### Contributors 142 | Thank you! 143 | 144 | [here will be your picture after your PR is merged] 145 | 146 | ## License 147 | [MIT](https://choosealicense.com/licenses/mit/) 148 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "code-bending-dict-react", 3 | "version": "0.1.0", 4 | "private": true, 5 | "dependencies": { 6 | "@testing-library/jest-dom": "^4.2.4", 7 | "@testing-library/react": "^9.3.2", 8 | "@testing-library/user-event": "^7.1.2", 9 | "react": "^16.13.1", 10 | "react-dom": "^16.13.1", 11 | "react-scripts": "3.4.3" 12 | }, 13 | "scripts": { 14 | "start": "react-scripts start", 15 | "build": "react-scripts build", 16 | "test": "react-scripts test", 17 | "eject": "react-scripts eject" 18 | }, 19 | "eslintConfig": { 20 | "extends": "react-app" 21 | }, 22 | "browserslist": { 23 | "production": [ 24 | ">0.2%", 25 | "not dead", 26 | "not op_mini all" 27 | ], 28 | "development": [ 29 | "last 1 chrome version", 30 | "last 1 firefox version", 31 | "last 1 safari version" 32 | ] 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sylwiavargas/The-Code-Bending-Dictionary-React/1f52c2e2552ff523b51f255ae814ba7f1177ae23/public/favicon.ico -------------------------------------------------------------------------------- /public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 12 | 13 | 17 | 18 | 27 | React App 28 | 29 | 30 | 31 |
32 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /public/logo192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sylwiavargas/The-Code-Bending-Dictionary-React/1f52c2e2552ff523b51f255ae814ba7f1177ae23/public/logo192.png -------------------------------------------------------------------------------- /public/logo512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sylwiavargas/The-Code-Bending-Dictionary-React/1f52c2e2552ff523b51f255ae814ba7f1177ae23/public/logo512.png -------------------------------------------------------------------------------- /public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "React App", 3 | "name": "Create React App Sample", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | }, 10 | { 11 | "src": "logo192.png", 12 | "type": "image/png", 13 | "sizes": "192x192" 14 | }, 15 | { 16 | "src": "logo512.png", 17 | "type": "image/png", 18 | "sizes": "512x512" 19 | } 20 | ], 21 | "start_url": ".", 22 | "display": "standalone", 23 | "theme_color": "#000000", 24 | "background_color": "#ffffff" 25 | } 26 | -------------------------------------------------------------------------------- /public/robots.txt: -------------------------------------------------------------------------------- 1 | # https://www.robotstxt.org/robotstxt.html 2 | User-agent: * 3 | Disallow: 4 | -------------------------------------------------------------------------------- /src/App.css: -------------------------------------------------------------------------------- 1 | .App { 2 | text-align: center; 3 | } 4 | 5 | .App-logo { 6 | height: 40vmin; 7 | pointer-events: none; 8 | } 9 | 10 | @media (prefers-reduced-motion: no-preference) { 11 | .App-logo { 12 | animation: App-logo-spin infinite 20s linear; 13 | } 14 | } 15 | 16 | .App-header { 17 | background-color: #282c34; 18 | min-height: 100vh; 19 | display: flex; 20 | flex-direction: column; 21 | align-items: center; 22 | justify-content: center; 23 | font-size: calc(10px + 2vmin); 24 | color: white; 25 | } 26 | 27 | .App-link { 28 | color: #61dafb; 29 | } 30 | 31 | @keyframes App-logo-spin { 32 | from { 33 | transform: rotate(0deg); 34 | } 35 | to { 36 | transform: rotate(360deg); 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /src/App.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import logo from './logo.svg'; 3 | import './App.css'; 4 | 5 | function App() { 6 | return ( 7 |
8 |
9 | logo 10 |

11 | Edit src/App.js and save to reload. 12 |

13 | 19 | Learn React 20 | 21 |
22 |
23 | ); 24 | } 25 | 26 | export default App; 27 | -------------------------------------------------------------------------------- /src/App.test.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { render } from '@testing-library/react'; 3 | import App from './App'; 4 | 5 | test('renders learn react link', () => { 6 | const { getByText } = render(); 7 | const linkElement = getByText(/learn react/i); 8 | expect(linkElement).toBeInTheDocument(); 9 | }); 10 | -------------------------------------------------------------------------------- /src/index.css: -------------------------------------------------------------------------------- 1 | body { 2 | margin: 0; 3 | font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 4 | 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 5 | sans-serif; 6 | -webkit-font-smoothing: antialiased; 7 | -moz-osx-font-smoothing: grayscale; 8 | } 9 | 10 | code { 11 | font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', 12 | monospace; 13 | } 14 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import ReactDOM from 'react-dom'; 3 | import './index.css'; 4 | import App from './App'; 5 | import * as serviceWorker from './serviceWorker'; 6 | 7 | ReactDOM.render( 8 | 9 | 10 | , 11 | document.getElementById('root') 12 | ); 13 | 14 | // If you want your app to work offline and load faster, you can change 15 | // unregister() to register() below. Note this comes with some pitfalls. 16 | // Learn more about service workers: https://bit.ly/CRA-PWA 17 | serviceWorker.unregister(); 18 | -------------------------------------------------------------------------------- /src/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /src/serviceWorker.js: -------------------------------------------------------------------------------- 1 | // This optional code is used to register a service worker. 2 | // register() is not called by default. 3 | 4 | // This lets the app load faster on subsequent visits in production, and gives 5 | // it offline capabilities. However, it also means that developers (and users) 6 | // will only see deployed updates on subsequent visits to a page, after all the 7 | // existing tabs open on the page have been closed, since previously cached 8 | // resources are updated in the background. 9 | 10 | // To learn more about the benefits of this model and instructions on how to 11 | // opt-in, read https://bit.ly/CRA-PWA 12 | 13 | const isLocalhost = Boolean( 14 | window.location.hostname === 'localhost' || 15 | // [::1] is the IPv6 localhost address. 16 | window.location.hostname === '[::1]' || 17 | // 127.0.0.0/8 are considered localhost for IPv4. 18 | window.location.hostname.match( 19 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/ 20 | ) 21 | ); 22 | 23 | export function register(config) { 24 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { 25 | // The URL constructor is available in all browsers that support SW. 26 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href); 27 | if (publicUrl.origin !== window.location.origin) { 28 | // Our service worker won't work if PUBLIC_URL is on a different origin 29 | // from what our page is served on. This might happen if a CDN is used to 30 | // serve assets; see https://github.com/facebook/create-react-app/issues/2374 31 | return; 32 | } 33 | 34 | window.addEventListener('load', () => { 35 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`; 36 | 37 | if (isLocalhost) { 38 | // This is running on localhost. Let's check if a service worker still exists or not. 39 | checkValidServiceWorker(swUrl, config); 40 | 41 | // Add some additional logging to localhost, pointing developers to the 42 | // service worker/PWA documentation. 43 | navigator.serviceWorker.ready.then(() => { 44 | console.log( 45 | 'This web app is being served cache-first by a service ' + 46 | 'worker. To learn more, visit https://bit.ly/CRA-PWA' 47 | ); 48 | }); 49 | } else { 50 | // Is not localhost. Just register service worker 51 | registerValidSW(swUrl, config); 52 | } 53 | }); 54 | } 55 | } 56 | 57 | function registerValidSW(swUrl, config) { 58 | navigator.serviceWorker 59 | .register(swUrl) 60 | .then(registration => { 61 | registration.onupdatefound = () => { 62 | const installingWorker = registration.installing; 63 | if (installingWorker == null) { 64 | return; 65 | } 66 | installingWorker.onstatechange = () => { 67 | if (installingWorker.state === 'installed') { 68 | if (navigator.serviceWorker.controller) { 69 | // At this point, the updated precached content has been fetched, 70 | // but the previous service worker will still serve the older 71 | // content until all client tabs are closed. 72 | console.log( 73 | 'New content is available and will be used when all ' + 74 | 'tabs for this page are closed. See https://bit.ly/CRA-PWA.' 75 | ); 76 | 77 | // Execute callback 78 | if (config && config.onUpdate) { 79 | config.onUpdate(registration); 80 | } 81 | } else { 82 | // At this point, everything has been precached. 83 | // It's the perfect time to display a 84 | // "Content is cached for offline use." message. 85 | console.log('Content is cached for offline use.'); 86 | 87 | // Execute callback 88 | if (config && config.onSuccess) { 89 | config.onSuccess(registration); 90 | } 91 | } 92 | } 93 | }; 94 | }; 95 | }) 96 | .catch(error => { 97 | console.error('Error during service worker registration:', error); 98 | }); 99 | } 100 | 101 | function checkValidServiceWorker(swUrl, config) { 102 | // Check if the service worker can be found. If it can't reload the page. 103 | fetch(swUrl, { 104 | headers: { 'Service-Worker': 'script' }, 105 | }) 106 | .then(response => { 107 | // Ensure service worker exists, and that we really are getting a JS file. 108 | const contentType = response.headers.get('content-type'); 109 | if ( 110 | response.status === 404 || 111 | (contentType != null && contentType.indexOf('javascript') === -1) 112 | ) { 113 | // No service worker found. Probably a different app. Reload the page. 114 | navigator.serviceWorker.ready.then(registration => { 115 | registration.unregister().then(() => { 116 | window.location.reload(); 117 | }); 118 | }); 119 | } else { 120 | // Service worker found. Proceed as normal. 121 | registerValidSW(swUrl, config); 122 | } 123 | }) 124 | .catch(() => { 125 | console.log( 126 | 'No internet connection found. App is running in offline mode.' 127 | ); 128 | }); 129 | } 130 | 131 | export function unregister() { 132 | if ('serviceWorker' in navigator) { 133 | navigator.serviceWorker.ready 134 | .then(registration => { 135 | registration.unregister(); 136 | }) 137 | .catch(error => { 138 | console.error(error.message); 139 | }); 140 | } 141 | } 142 | -------------------------------------------------------------------------------- /src/setupTests.js: -------------------------------------------------------------------------------- 1 | // jest-dom adds custom jest matchers for asserting on DOM nodes. 2 | // allows you to do things like: 3 | // expect(element).toHaveTextContent(/react/i) 4 | // learn more: https://github.com/testing-library/jest-dom 5 | import '@testing-library/jest-dom/extend-expect'; 6 | --------------------------------------------------------------------------------