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

Commit 702379e

Browse files
author
dpatanin
committed
update README
1 parent 4b500bd commit 702379e

2 files changed

Lines changed: 27 additions & 3 deletions

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,26 @@
11
# LandingPage secureCodeBox
22

3-
This repository sources the [secureCodeBox landing page][prod-website].
3+
This repository sources the [securecodebox.io] Website. Our Webpage is meant to provide an extensive documentation about our [secureCodeBox] and many helpful guides on how to start and operate it. The Website is build with the [GatsbyJS] Framework and hosted through [GitHub Pages]. All important decision about this website are documented in our `/adr` folder. If you want to contribute to our Website, please follow the Style Guide down below.
44

55
## Build and Run
66

7+
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.
15+
Finally you download/clone this repository and install all required Node modules:
16+
17+
```bash
18+
git clone https://github.com/secureCodeBox/securecodebox.github.io.git
19+
cd securecodebox.github.io
20+
npm install
21+
```
22+
Done! :) Now you can start developing and contributing.
23+
724
For development:
825
```bash
926
gatsby develop
@@ -57,3 +74,10 @@ Icons should be license free and as close too the other icons' style as possible
5774
- [iconmonstr](https://iconmonstr.com/)
5875
- [pixabay](https://pixabay.com/)
5976

77+
78+
79+
[securecodebox.io]: https://securecodebox.github.io
80+
[secureCodeBox]: https://github.com/secureCodeBox/secureCodeBox
81+
[GatsbyJS]: https://www.gatsbyjs.org/
82+
[GitHub Pages]: https://pages.github.com/
83+
[Node.js and NPM]: https://nodejs.org/en/download/

adr/adr_0001.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ https://jekyllrb.com/[Jekyll]
3939
=== Research
4040

4141
These frameworks do all fulfill the requirements to the extent that I estimate them as wellsuited. First, I researched the listed features on the respective sites or quickly googled after it
42-
specifically and found instantly the requested feature. I followed up with in general overview
42+
specifically and found instantly the requested feature. I followed up with a general overview
4343
of how old the frameworks, how popular they are and for example pages build with them.
4444
Afterwards I searched for comparison blogs and posts, mostly to examine their comments.
4545
Most of these „pro-cons “-posts are inaccurate and very superficial, but luckily because of that
@@ -69,7 +69,7 @@ other framework we considered mainly) is based on Golang, and as for my part as
6969
feel completely comfortable and prefer working with JSX. Overall it comes down to preferences mostly, since we’re not going to build a giant Website, nor are we planning on implementing “crazy” Features.
7070

7171
== Consequences
72-
a
72+
7373
For the integration of our multi-repository documentation we’ll use
7474
Antora if working this out with Gatsby is going to be more difficult than integrating Antora.
7575
We’re aware that using Gatsby requires a bit more maintenance and has the drawback, that if

0 commit comments

Comments
 (0)