danvics/ProzillaOS
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated deployment process

Browse source
This commit is contained in:
Prozilla 2023-07-23 17:50:12 +02:00
parent 3d14013eea
commit af5f8a1e94
No known key found for this signature in database
GPG key ID: 5858DFE71CAF31EE
4 changed files with 17828 additions and 17805 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
deploy.sh Normal file
View file

@ -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

11
docs/README.md
View file

@ -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.
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 and then push the build folder to a branch called `gh-pages`.
3. Configure your GitHub Pages to deploy the `gh-pages` branch.
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. 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`.
3. Configure your GitHub Pages to deploy the `gh-pages` branch to your domain.
### Structure

20
package-lock.json generated
View file

@ -16,6 +16,7 @@
"@testing-library/react": "^13.4.0",
"@testing-library/user-event": "^13.5.0",
"core-js": "^3.31.1",
"dotenv": "^16.3.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-draggable": "^4.4.5",
@ -7045,11 +7046,14 @@
}
},
"node_modules/dotenv": {
"version": "10.0.0",
"resolved": "https://registry.npmjs.org/dotenv/-/dotenv-10.0.0.tgz",
"integrity": "sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==",
"version": "16.3.1",
"resolved": "https://registry.npmjs.org/dotenv/-/dotenv-16.3.1.tgz",
"integrity": "sha512-IPzF4w4/Rd94bA9imS68tZBaYyBWSCE47V1RGuMrB94iyTOIEwRmVL2x/4An+6mETpLrKJ5hQkB8W4kFAadeIQ==",
"engines": {
"node": ">=10"
"node": ">=12"
},
"funding": {
"url": "https://github.com/motdotla/dotenv?sponsor=1"
}
},
"node_modules/dotenv-expand": {
@ -14822,6 +14826,14 @@
}
}
},
"node_modules/react-scripts/node_modules/dotenv": {
"version": "10.0.0",
"resolved": "https://registry.npmjs.org/dotenv/-/dotenv-10.0.0.tgz",
"integrity": "sha512-rlBi9d8jpv9Sf1klPjNfFAuWDjKLwTIJJ/VxtoTwIR6hnZxcEOQCZg2oIL3MWBYw5GpUDKOEnND7LXTbIpQ03Q==",
"engines": {
"node": ">=10"
}
},
"node_modules/react-svg": {
"version": "16.1.18",
"resolved": "https://registry.npmjs.org/react-svg/-/react-svg-16.1.18.tgz",

3
package.json
View file

@ -4,6 +4,7 @@
"private": false,
"author": "Prozilla",
"homepage": "https://os.prozilla.dev/",
"repository": "https://github.com/Prozilla/Prozilla-OS",
"dependencies": {
"@fortawesome/fontawesome-svg-core": "^6.4.0",
"@fortawesome/free-regular-svg-icons": "^6.4.0",
@ -26,7 +27,7 @@
"test": "react-scripts test",
"eject": "react-scripts eject",
"predeploy": "npm run build",
"deploy": "gh-pages -d build -m \"Deployed build to GitHub Pages\""
"deploy": "sh deploy.sh"
},
"eslintConfig": {
"extends": [