From 240f5c7fbc97d26f1dc7f0e0dbbbd6da6d98fcc0 Mon Sep 17 00:00:00 2001 From: "Rachel Soae Prather (she/her)" <118572701+rachelsoae@users.noreply.github.com> Date: Wed, 3 Jan 2024 13:41:03 -0800 Subject: [PATCH] Update README.md --- README.md | 112 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 66 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 58beeac..67ba303 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,90 @@ -# Getting Started with Create React App + -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). + +
-## Available Scripts +
+ + Logo + +
+
+
+ + Click to Enter Site + +
-In the project directory, you can run: + -### `npm start` +## Table of Contents + -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in your browser. + +## About the Site -The page will reload when you make changes.\ -You may also see any lint errors in the console. +### Built With -### `npm test` +![JavaScript][JavaScript] +[![React][React]][React-url] +[![Sass][Sass]][Sass-url] +[![Cypress][Cypress]][Cypress-url] -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. +

(back to top)

-### `npm run build` + +## Getting Started -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. +To demo this site on your local machine, follow these steps: -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! +1. Clone down this repository +1. `cd` into the directory +1. Run `npm i` to install dependencies +1. Run `npm start` to view live in your browser -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. +

(back to top)

-### `npm run eject` + + +## Roadmap +Additional features, functionality, and potential refactors: + * UI Testing + * Advanced UI features, such as dark mode -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. +

(back to top)

-## Learn More -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). + +## Acknowledgments -To learn React, check out the [React documentation](https://reactjs.org/). +Huge thanks go out to [Laura Garcia Guerra](https://www.lauragarciaguerra.com/) for your invaluable advice and code reviews! -### Code Splitting +

(back to top)

-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) -### Analyzing the Bundle Size + + +[linkedin-shield]: https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white +[rachel-li-url]: https://www.linkedin.com/in/rachel-soae-prather/ +[Github]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white +[rachel-gh-url]: https://github.com/rachelsoae +[JavaScript]: https://img.shields.io/badge/JavaScript-%23F7DF1E?style=for-the-badge&logo=javascript&logoColor=black +[React]: https://img.shields.io/badge/React-%2361DAFB?style=for-the-badge&logo=react&logoColor=black +[React-url]: https://react.dev/ +[Sass]: https://img.shields.io/badge/Sass-%23CC6699?style=for-the-badge&logo=sass&logoColor=white +[Sass-url]: https://sass-lang.com/ +[Cypress]: https://img.shields.io/badge/Cypress-%2317202C?style=for-the-badge&logo=cypress&logoColor=white +[Cypress-url]: https://docs.cypress.io/guides/overview/why-cypress -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](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](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](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](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](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)