Updated deployment process

deploy.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+DOMAIN=os.prozilla.dev
+COMMIT_MESSAGE="Deployed build to GitHub Pages"
+REPO_URL="https://github.com/Prozilla/Prozilla-OS"
+
+echo $DOMAIN > build/CNAME
+echo Deploying to GitHub Pages...
+gh-pages -d build -m $COMMIT_MESSAGE -r $REPO_URL

docs/README.md

@@ -1,3 +1,5 @@
+[← Back](../README.md)
+
 # Documentation
 
 ## Table of Contents
@@ -25,12 +27,11 @@
 1. Run `npm run build`, which will compile all the necessary files to the `build` directory.
 2. Upload the contents of the `build` directory to your web server's root folder.
 
-#### Deploy to GitHub Pages
+#### Deploying to GitHub Pages
 
-1. Change the "homepage" property in [package.json](../package.json) to your domain.
+1. Open [deploy.sh](../deploy.sh) and change `DOMAIN` to your domain, `COMMIT_MESSAGE` to your commit message and `REPO_URL` to the URL of your repo. Make sure you don't add or remove any quotes when editing these values.
-2. Make sure the package `gh-pages` is installed.
+2. Run `npm run deploy` - This will create a new build by running the redeploy script, add a CNAME pointing to your domain and then push the build folder to a branch called `gh-pages`.
-2. Run `npm run deploy` - This will create a new build by running the redeploy script and then push the build folder to a branch called `gh-pages`.
+3. Configure your GitHub Pages to deploy the `gh-pages` branch to your domain.
-3. Configure your GitHub Pages to deploy the `gh-pages` branch.
 
 ### Structure
 
@@ -48,4 +49,4 @@
 
 - [build](../build) directory
 
-	Contains the static build files after [building](#building--deploying) the application. This directory is not included in the GitHub repository.
+	Contains the static build files after [building](#building--deploying) the application. This directory is not included in the GitHub repository.

package.json

@@ -1,52 +1,53 @@
 {
-  "name": "prozilla-os",
+	"name": "prozilla-os",
-  "version": "0.1.0",
+	"version": "0.1.0",
-  "private": false,
+	"private": false,
-  "author": "Prozilla",
+	"author": "Prozilla",
-  "homepage": "https://os.prozilla.dev/",
+	"homepage": "https://os.prozilla.dev/",
-  "dependencies": {
+	"repository": "https://github.com/Prozilla/Prozilla-OS",
-    "@fortawesome/fontawesome-svg-core": "^6.4.0",
+	"dependencies": {
-    "@fortawesome/free-regular-svg-icons": "^6.4.0",
+		"@fortawesome/fontawesome-svg-core": "^6.4.0",
-    "@fortawesome/free-solid-svg-icons": "^6.4.0",
+		"@fortawesome/free-regular-svg-icons": "^6.4.0",
-    "@fortawesome/react-fontawesome": "^0.2.0",
+		"@fortawesome/free-solid-svg-icons": "^6.4.0",
-    "@testing-library/jest-dom": "^5.16.5",
+		"@fortawesome/react-fontawesome": "^0.2.0",
-    "@testing-library/react": "^13.4.0",
+		"@testing-library/jest-dom": "^5.16.5",
-    "@testing-library/user-event": "^13.5.0",
+		"@testing-library/react": "^13.4.0",
-    "core-js": "^3.31.1",
+		"@testing-library/user-event": "^13.5.0",
-    "react": "^18.2.0",
+		"core-js": "^3.31.1",
-    "react-dom": "^18.2.0",
+		"react": "^18.2.0",
-    "react-draggable": "^4.4.5",
+		"react-dom": "^18.2.0",
-    "react-scripts": "5.0.1",
+		"react-draggable": "^4.4.5",
-    "react-svg": "^16.1.18",
+		"react-scripts": "5.0.1",
-    "web-vitals": "^2.1.4"
+		"react-svg": "^16.1.18",
-  },
+		"web-vitals": "^2.1.4"
-  "scripts": {
+	},
-    "start": "react-scripts start",
+	"scripts": {
-    "build": "react-scripts build",
+		"start": "react-scripts start",
-    "test": "react-scripts test",
+		"build": "react-scripts build",
-    "eject": "react-scripts eject",
+		"test": "react-scripts test",
-    "predeploy": "npm run build",
+		"eject": "react-scripts eject",
-    "deploy": "gh-pages -d build -m \"Deployed build to GitHub Pages\""
+		"predeploy": "npm run build",
-  },
+		"deploy": "sh deploy.sh"
-  "eslintConfig": {
+	},
-    "extends": [
+	"eslintConfig": {
-      "react-app",
+		"extends": [
-      "react-app/jest"
+			"react-app",
-    ]
+			"react-app/jest"
-  },
+		]
-  "browserslist": {
+	},
-    "production": [
+	"browserslist": {
-      ">0.2%",
+		"production": [
-      "not dead",
+			">0.2%",
-      "not op_mini all"
+			"not dead",
-    ],
+			"not op_mini all"
-    "development": [
+		],
-      "last 1 chrome version",
+		"development": [
-      "last 1 firefox version",
+			"last 1 chrome version",
-      "last 1 safari version"
+			"last 1 firefox version",
-    ]
+			"last 1 safari version"
-  },
+		]
-  "devDependencies": {
+	},
-    "gh-pages": "^5.0.0"
+	"devDependencies": {
-  }
+		"gh-pages": "^5.0.0"
+	}
 }