Replace all ToDo notes with the appropriate names, descriptions and commands.
ToDo: Description of the project.
ToDO: Replace hugo-boilerplate with your project name in the badge links
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
To build the project, the following prerequisites must be met:
If you don't want to install all prerequisites directly on your machine and instead use a Docker environment with all prerequisites already installed and configured, you can check out the Docker environment section.
Get a copy of the repository:
ToDo: git clone git@github.com:noi-techpark/hugo-boilerplate.gitChange directory:
ToDo: cd hugo-boilerplateTo start a local webserver that serves the project, simply run the following command:
hugo server -s srcThe website will be available at http://127.0.0.1:1313. It also recompiles automatically if you make any change to the source code.
To deploy the website, simply run the command hugo -s src -d ../target from the root folder of the project. The final version of the website will then be generate inside the target folder.
For the project a Docker environment is already prepared and ready to use with all necessary prerequisites.
These Docker containers are the same as used by the continuous integration servers.
Install Docker (with Docker Compose) locally on your machine.
Before start working you have to start the Docker containers:
docker-compose up --build --detach
The website will be available at http://127.0.0.1:1313. It also recompiles automatically if you make any change to the source code.
After finished working you can stop the Docker containers:
docker-compose stop
ToDo: For support, please contact info@opendatahub.bz.it.
If you'd like to contribute, please follow the following instructions:
https://docs.opendatahub.bz.it/en/latest/guidelines/contributors.html
More documentation can be found at https://opendatahub.readthedocs.io/en/latest/index.html.
The project uses this boilerplate: https://github.com/noi-techpark/hugo-boilerplate.
The code in this project is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3 license. See the LICENSE.md file for more information.
This project is REUSE compliant, more information about the usage of REUSE in NOI Techpark repositories can be found here.
Since the CI for this project checks for REUSE compliance you might find it useful to use a pre-commit hook checking for REUSE compliance locally. The pre-commit-config file in the repository root is already configured to check for REUSE compliance with help of the pre-commit tool.
Install the tool by running:
pip install pre-commitThen install the pre-commit hook via the config file by running:
pre-commit install