Developers Italia

We develop public services, together

Website | Reuse Catalog | publiccode.yml | Contributing

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 and it's currently served through GitHub pages.

A CircleCI job builds the sources and commits the resulting artifacts to GitHub, in the gh-pages branch. The same job is also triggered every night to get the most updated data feeding the website.

Documentation

Development

A development environment can be both brought up directly on the developer machine and in form of a Docker container.

The same commands -run in the Dockerfile- can also be run directly on the developer machine.

The docker-compose.yml file uses environment variables declared in the file .env file, in the root directory. Please refer to .env.example for the detailed description of those variables.

Before proceeding, copy the .env.example into .env and modify the environment variables as needed.

Then, build the container, running:

docker-compose up [-d] [--build]

where:

-d execute the containers in background
--build forces the containers build

To destroy the containers, use:

docker-compose down

Wait until the Docker logs explicitly say that the website is served on 0.0.0.0:4000. Then, open a browser and navigate to http://localhost:4000 to preview the website.

Recompile handlebars templates

Within folder _templates live some handlebars templates that operate in various areas. Once they get modified it is necessary recompile them. To do that we can use npx utility as follow:

npx [email protected] _templates/search.handlebars -f assets/templates/search.tpl.js

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

The source code is released under the BSD license (code SPDX: 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.

anto90e / developers.italia.it Goto Github PK