README.md 1.62 KB
Newer Older
1
# Federal Developer Portal (Förderales Entwicklungsportal)
2
<img src="public/img/kabelmaennchen_construct.svg" style="width:100px;"/>
3

4
The developer portal bundles developer resources (documentation, API specifications and code samples) about German government IT systems.
5
The live version is available here: [https://docs.fitko.de](https://docs.fitko.de)
6

Marco Holz's avatar
Marco Holz committed
7
## How to build
8

9
To build the developer portal locally [yarn package manager](https://yarnpkg.com/) is recommended.
10

11
12
13
14
15
16
### Preconditions
To install yarn:
```sh
npm install --global yarn
```

17
Before proceeding, double check if yarn is installed correctly:
18
19
20
21
22
23
24
25
26
27
```sh
yarn --version
```
### Development build
For the federal developer portal running in dev mode run:
```sh
yarn install
yarn dev
```

28
By default, the server runs on [http://localhost:3000](http://localhost:3000)
29

30
31
32
33
34
35
36
37
38
### Deployable build
Build a fully deployable export with:
```sh
yarn install
yarn export
```
The result is stored in a sub folder of project root called `out`.

## Continous Integration
39
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.
40
41
42
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
Marco Holz's avatar
Marco Holz committed
43
44
Source code is licensed under the [EUPL](LICENSES/EUPL-1.2.txt).

45
Unless stated otherwise, the content of this website is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).