Description

This repository is the source for https://contributors.free.technology/.

It is built using mdBook.

Development

GitHub

The simplest way to make changes is by editing files on GitHub and creating Pull Requests.

A simple alternative to using the GitHub Web UI is using their Desktop Application.

Local Build

Clone repository locally using Git:

git clone https://github.com/status-im/contributors.free.technology.git

You will need to install mdBook.

To start a server that also builds the page use:

cd contributors.free.technology
mdbook serve

Will expose the built page under http://localhost:3000/.

Continuous Integration

PRs should be made for develop branch and master should be rebased on develop once changes are verified.

• CI builds master and pushes to deploy-master branch, which is hosted at https://contributors.free.technology/.
• CI builds develop and pushes to deploy-develop branch, which is hosted at https://dev-contributors.free.technology/.

The hosting is done using Caddy server with Git plugin for handling GitHub webhooks.

Information about deployed build can be also found in /build.json available on the website.