Commit dc8c8bda authored by René Rösner's avatar René Rösner
Browse files

Fix: Review feedback(planning#422)

parent 8cd5a701
# Föderales Entwicklungsportal
<img src="public/img/kabelmaennchen_construct.svg" alt="kabelmaennchen_construct_drawing" style="width:200px;"/>
# Federal Developer Portal (Förderales Entwicklungsportal)
<img src="public/img/kabelmaennchen_construct.svg" style="width:200px;"/>
The federal developer portal bundles developer resources (documentation, API specifications and code samples) about German government IT systems.
The developer portal bundles developer resources (documentation, API specifications and code samples) about German government IT systems.
The live version is available here: [https://docs.fitko.de](https://docs.fitko.de)
## How to build
To build the federal developer portal locally [yarn package manager](https://yarnpkg.com/) is recommended.
To build the developer portal locally [yarn package manager](https://yarnpkg.com/) is recommended.
### Preconditions
To install yarn:
......@@ -14,7 +14,7 @@ To install yarn:
npm install --global yarn
```
Before proceeding double check if yarn is installed correctly:
Before proceeding, double check if yarn is installed correctly:
```sh
yarn --version
```
......@@ -25,7 +25,7 @@ yarn install
yarn dev
```
By default the server provides the portal on [http://localhost:3000](http://localhost:3000)
By default, the server runs on [http://localhost:3000](http://localhost:3000)
### Deployable build
Build a fully deployable export with:
......@@ -36,7 +36,7 @@ yarn export
The result is stored in a sub folder of project root called `out`.
## Continous Integration
Every incomming commit triggers our gitlab pipeline. For details check the configuration in the YAML file: `ci/gitlab-ci.yml`. In order to ensure a high code quality, static code analysis are triggert before deployment.
Every incomming commit triggers our gitlab pipeline. For details check the configuration in the YAML file: `ci/gitlab-ci.yml`. In order to ensure a high code quality, static code analysis are triggered before deployment.
Licensing of the files works with a tool called Reuse. As soon as new files are added, the Reuse configuration(`.reuse/dep5`) must be extended accordingly.
## Licenses
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment