Skip to content
This repository was archived by the owner on Apr 21, 2026. It is now read-only.

Commit 7b02cd0

Browse files
authored
Add production deployment guide to readme
1 parent fa7cdda commit 7b02cd0

1 file changed

Lines changed: 8 additions & 12 deletions

File tree

README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,6 @@ This repository sources the [securecodebox.io] website. Our webpage is meant to
55
## Build and Run
66

77
In order to build and run this website you need to install [Node.js and NPM] for your platform.
8-
If installed run
9-
10-
```
11-
npm install -g gatsby-cli
12-
```
13-
14-
to install the required Gatsby CLI.
158
Finally you download/clone this repository and install all required Node modules:
169

1710
```bash
@@ -23,16 +16,15 @@ Done! :) Now you can start developing and contributing.
2316

2417
For development:
2518
```bash
26-
gatsby develop
19+
npm run develop
2720
```
2821
For production locally:
2922
```bash
30-
gatsby build
31-
gatsby serve
23+
npm run build
24+
npm run serve
3225
```
3326
And then visit [this](http://localhost:8000/) in your browser.
3427

35-
3628
## Style Guide
3729

3830
The overall design-idea is a clean and professional look. And since securecodebox.io serves mostly an informational purpose, it should stay more simplistic than extraordinary, meaning include only information and elements which either are necessary or helpful and very few basic elements for a good look (e.g. fitting background picture).
@@ -74,10 +66,14 @@ Icons should be license free and as close to the other icons' style as possible.
7466
- [iconmonstr](https://iconmonstr.com/)
7567
- [pixabay](https://pixabay.com/)
7668

69+
## Production Deployment
7770

71+
All changes pushed to the `gh-source` branch get automatically build by GitHub Actions.
72+
The artifacts of the build, aka. the build site, gets forced pushed to the master branch.
73+
The master branch then gets automatically deployed as a GitHub Page.
7874

7975
[securecodebox.io]: https://securecodebox.github.io
8076
[secureCodeBox]: https://github.com/secureCodeBox/secureCodeBox
8177
[GatsbyJS]: https://www.gatsbyjs.org/
8278
[GitHub Pages]: https://pages.github.com/
83-
[Node.js and NPM]: https://nodejs.org/en/download/
79+
[Node.js and NPM]: https://nodejs.org/en/download/

0 commit comments

Comments
 (0)