2
0
mirror of https://github.com/offen/website.git synced 2024-11-23 09:20:33 +01:00
website/README.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

2020-06-01 11:17:25 +02:00
<a href="https://offen.dev/">
<img src="https://offen.github.io/press-kit/offen-material/gfx-GitHub-Offen-logo.svg" alt="Offen logo" title="Offen" width="150px"/>
</a>
2019-04-26 04:19:47 +02:00
2020-06-01 11:17:25 +02:00
# Website
[![CircleCI](https://circleci.com/gh/offen/website/tree/master.svg?style=svg)](https://circleci.com/gh/offen/website/tree/master)
2020-01-07 13:30:24 +01:00
## The www.offen.dev website
2019-04-10 18:17:24 +02:00
2020-01-07 13:30:24 +01:00
This repository contains the source code for the <https://www.offen.dev> website.
2019-04-10 18:17:24 +02:00
---
2019-04-19 18:56:24 +02:00
### Developing the application
The development setup requires `docker` and `docker-compose` to be installed.
2019-04-26 04:08:17 +02:00
After cloning the repository, you can build the containers and install dependencies using:
```sh
$ make setup
```
You can test your setup by starting the application:
```sh
$ make up
2019-04-26 04:08:17 +02:00
```
2020-01-07 13:30:24 +01:00
which should enable you to access the homepage at <http://localhost:8000/>.
2019-04-26 04:08:17 +02:00
2019-04-10 18:17:24 +02:00
### License
The content of this website itself is licensed under the [Creative Commons Attribution 4.0 International (CC BY 4.0) License][cc-by-4], and the underlying source code used to format and display that content is licensed under the [GNU Affero General Public License v3.0][license].
[cc-by-4]: https://creativecommons.org/licenses/by/4.0/
[license]: https://github.com/offen/website/blob/development/LICENSE