-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c1d6fb4
commit 240f5c7
Showing
1 changed file
with
66 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,90 @@ | ||
| # Getting Started with Create React App | ||
| <a name="readme-top"></a> | ||
|
|
||
| This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). | ||
| <!-- PROJECT LOGO --> | ||
| <br /> | ||
|
|
||
| ## Available Scripts | ||
| <div align="center"> | ||
| <a href="https://www.rachelsoae.com"> | ||
| <img src="./src/assets/logo.png" alt="Logo" width="600" margin="0"> | ||
| </a> | ||
| </div> | ||
| <br /> | ||
| <div align="center"> | ||
| <a href="https://www.rachelsoae.com"> | ||
| Click to Enter Site | ||
| </a> | ||
| </div> | ||
|
|
||
| In the project directory, you can run: | ||
| <!-- TABLE OF CONTENTS --> | ||
|
|
||
| ### `npm start` | ||
| ## Table of Contents | ||
| <ul> | ||
| <li><a href="#built-with">Built With</a></li> | ||
| <li><a href="#getting-started">Getting Started</a></li> | ||
| <!-- <li><a href="#testing">Testing</a></li> --> | ||
| <li><a href="#roadmap">Roadmap</a></li> | ||
| <li><a href="#acknowledgments">Acknowledgments</a></li> | ||
| </ul> | ||
|
|
||
| Runs the app in the development mode.\ | ||
| Open [http://localhost:3000](http://localhost:3000) to view it in your browser. | ||
| <!-- ABOUT THE SITE--> | ||
| ## 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. | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| ### `npm run build` | ||
| <!-- GETTING STARTED --> | ||
| ## 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. | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| ### `npm run eject` | ||
| <!-- Testing --> | ||
| <!-- ## Testing | ||
| **Note: this is a one-way operation. Once you `eject`, you can't go back!** | ||
| After installation, run `npm run cypress open` to view and run the test suite. *All tests passing at time of writing.* | ||
| 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. | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| 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. | ||
| <!-- Roadmap --> | ||
| ## 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. | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| ## Learn More | ||
|
|
||
| You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). | ||
| <!-- ACKNOWLEDGMENTS --> | ||
| ## 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 | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| 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 | ||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| [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) |