Dictionary for Devs

Dictionary for Devs was an idea created by Jess Lark and used as a project by the Phoenix React Meetup Group. Later, during Hacktobertfest 2018, Jess started a fresh approach to the DFD as a shallow dive into open source. The DFD is a collection of terms, phrases, and acronyms that are assumed knowledge in the dev community but may be unfamiliar to new, or even seasoned, developers.

Note to Windows Users

This file was written by someone using a Mac, and should work for Linux and Mac users. Please be aware that some things will be different for Windows users. Feel free to add additional information or create a whole separate Windows readme file. Thanks!

What to Contribute

• Offer a new definition or a new feature. Use the 'Resources' guide below to learn how to make a PR.

Contributing Cheat Sheet

(in progress, please update if an error is found, or to add additonal context or details)

Start: clone the code and switch into the new directory

At the command line:

• npm i
• nvm use
• npm start
• make a new branch
• make changes
• npm run build (this step is important, your changes will be in the repo but not deployed to the web app without it)
• commit and push changes
• make a pull request

Resources

• How to do your first pull request: https://github.com/jessmear/dictionary-for-devs/blob/master/pull-request-basics.md
• Markdown cheat sheet: https://www.makeuseof.com/tag/printable-markdown-cheat-sheet/
  • (Alternative) https://guides.github.com/features/mastering-markdown/
• How to Contribute to Open Source: https://opensource.guide/how-to-contribute/
• Hacktoberfest: https://hacktoberfest.digitalocean.com/

Possible TODO

Implememnt Sass Make header, footer, and search smaller and sticky

Clean up code, move pieces into appropriate components, order functions appropriately Make scrollToTop smooth Update search to allow for searching on words or defs or both Allow for multiple definitions Specifically add an ELI5 defintion for each term Consider useReducer instead of useState Improve design Move dictionary content into database Add functionality for users to add definitions to database Add funcationality for moderators to clean up any issues Consider pulling in dictionary defs (or some other source) from an API Add code snippets for explanations where appropriate Add links to defs where appropriate

Major Revisions

July 2019: Port project into React October 2018: Move definitions out of HTML and into external file October 2018: Initialize project

Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm i

This uses the package.json file to install dependencies.

nvm use

This uses the .nvmrc file to set node to the currently supported version. If you encounter an error, make sure you have NVM installed. Visit https://nvm.sh to learn more.

npm start

Runs 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 test

Launches the test runner in the interactive watch mode.
See the section about 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 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.

To learn React, check out the React documentation.

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