Merge pull request #4 from petertonysmith94/feature/pages

Feature/pages

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "files.exclude": {
+    "**/.git": true,
+    "node_modules": true,
+    "build": true
+  }
+}

README.md

@@ -1,46 +1,21 @@
-# Getting Started with Create React App
+# P
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+## Getting started
 
-## Available Scripts
+```sh
+pnpm install
+```
 
-In the project directory, you can run:
+## Documentation
 
-### `pnpm start`
+- Converting our SVG to PNG (move into commands)
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+```sh
+# https://www.npmjs.com/package/svg2png
+rm ./public/logo.192.png
+svg2png ./public/favicon.svg --width=192 --height=192 --output="./public/logo.192.png"
+```
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+- SVG Based Favicons
 
-### `pnpm 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.
-
-### `pnpm 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](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `pnpm 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](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+[Source1](https://medium.com/swlh/are-you-using-svg-favicons-yet-a-guide-for-modern-browsers-836a6aace3df)

config-overrides.js

@@ -0,0 +1,14 @@
+/**
+ * Provides a way to add custom webpack config
+ * 
+ * @param {*} config webpack config
+ * @param {*} env the environment
+ */
+module.exports = function override(config, env) {
+  config.module.rules.push({
+    test: /\.md$/,
+    type: 'asset/source',
+  })
+
+  return config;
+}

package.json

@@ -21,12 +21,13 @@
     "@types/node": "^16.18.38",
     "@types/react": "^18.2.15",
     "@types/react-dom": "^18.2.7",
-    "gh-pages": "^5.0.0"
+    "gh-pages": "^5.0.0",
+    "react-app-rewired": "^2.2.1"
   },
   "scripts": {
-    "start": "react-scripts start",
-    "build": "react-scripts build",
-    "test": "react-scripts test",
+    "start": "react-app-rewired start",
+    "build": "react-app-rewired build",
+    "test": "react-app-rewired test",
     "eject": "react-scripts eject",
     "deploy": "gh-pages -d build"
   },