Skip to content

Latest commit

 

History

History
138 lines (103 loc) · 3.93 KB

README.md

File metadata and controls

138 lines (103 loc) · 3.93 KB
Raw

Developers Italia


We develop public services, together

Description

Developers Italia is the reference point for the community of developers creating the next generation of digital public services in Italy.

This repository contains the sources of the website. The website is developed using Jekyll.

A GitHub action job builds the sources, getting some data from developers.italia.it-data, and commits the resulting artifacts to the gh-pages branch. The job is also triggered every night to get the latest data.

Documentation

Development

We use Docker and docker-compose to bring up the developer environment, just clone the repo and

  1. Copy the .env.example file into .env and modify the environment variables as it suits you. .env.example holds the detailed description of each variable.

    cp .env.example .env

  2. Set the RUNAS variable to your user:

    echo RUNAS=$(id -u):$(id -g) >> .env

  3. Build the container:

    docker-compose up

Wait until the Docker logs explicitly say that the website is served at 0.0.0.0:4000 and navigate to http://localhost:4000 to preview the website.

Jekyll will pick up changes to the Markdown files and recompile them on the fly.

If you change the Gemfile or package.json, you'll need to rebuild the image with:

docker-compose up --build

Makefile

Both the CircleCI build and the Docker files leverage a Makefile, facilitating the execution of more complex routines. You can have a look at the Makefile to know more about the exact commands used to build the website.

Community

Code of Conduct

Please review our Code of Conduct to ensure a great collaboration with the rest of the community.

Contributing

Developers Italia exists also thanks to your contributions! Here is a list of users who already contributed to this repository:

This list is also displayed in the Developers Italia website.

Every contribution is welcome! However, before proceeding further please take a look at our contributing guidelines.

License

Copyright© 2018-present - Presidenza del Consiglio dei Ministri

The source code is released under the BSD license (SPDX code: BSD-3-Clause) and it's distributed with this license since May 30th 2018.

The previous code has been released under under the MIT license.