From 1878246ba166f0d9c47689503ffc29253d07ea14 Mon Sep 17 00:00:00 2001 From: "Mr. Singleton" Date: Mon, 2 Oct 2023 06:26:18 -0400 Subject: [PATCH] readme update --- README.md | 137 ++++++++++++------------------------------------------ 1 file changed, 30 insertions(+), 107 deletions(-) diff --git a/README.md b/README.md index b973209e..3e43a8f4 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ -# Mixed Feelings By T +# React Website Builder -Application that serves as the website for Mixed Feelings By T +Application that serves as the website builder from React Components ## Description -Client project for Mixed Feelings by T. Serves as central location for music, media, and other content. -Links for purchase of music and place for performance updates. +Client project. + +This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). + ## Getting Started @@ -16,121 +18,42 @@ Links for purchase of music and place for performance updates. * firebase ### Installing +#### UI +* ```npm install``` -* npm install +#### Functions +* ```cd functions``` +* ```npm install``` ### Executing program +#### UI +* ```npm start``` +#### Functions +* ```npm serve``` +#### Sanity +* ```npm run dev``` -* yarn -* Step-by-step bullets -``` -code blocks for commands -``` +### Deployment +#### First Build UI +* ```npm build``` +#### Then Build Functions +* ```cd functions``` +* ```npm build``` +* ```npm html``` +* ```firebase deploy``` +#### Sanity +* ```sanity deploy``` ## Help -Any advise for common problems or issues. -``` -command to run if program contains helper info -``` ## Authors Contributors names and contact info -ex. Dominique Pizzie -ex. [@DomPizzie](https://twitter.com/dompizzie) - -## Version History - -* 0.2 - * Various bug fixes and optimizations - * See [commit change]() or See [release history]() -* 0.1 - * Initial Release +James Singleton +The Handsomest Nerd ## License -This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details - -## Acknowledgments - -Inspiration, code snippets, etc. -* [awesome-readme](https://github.com/matiassingers/awesome-readme) -* [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) -* [dbader](https://github.com/dbader/readme-template) -* [zenorocha](https://gist.github.com/zenorocha/4526327) -* [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46) - - - -# Getting Started with Create React App - -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). - -## Available Scripts - -In the project directory, you can run: - -### `yarn start` - -Runs the app in the development mode.\ -Open [http://localhost:3000](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. - -### `yarn test` - -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. - -### `yarn 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](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `yarn 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](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### Code Splitting - -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 - -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) - -### `yarn 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) +This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details \ No newline at end of file