Skip to content

Latest commit

 

History

History
109 lines (77 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

109 lines (77 loc) · 3.51 KB

✨ Contributing to QGIS-Changelog-Website

Thank you for your interest in contributing to the QGIS Changelog Website! We welcome all types of contributions, including bug reports, feature suggestions, code improvements, and documentation updates. Please review the guidelines below to help ensure a smooth and effective contribution process.

-----------------------------------------------------

🧑💻 Development Setup

To get started with development, you can run the application in debug mode using Docker Compose. Several helpful Docker Compose commands are already defined in the deployment/Makefile.

🏃 Prerequisites

This project requires Docker and Docker Compose for both development and production environments. Please make sure both are installed on your system before proceeding.

Docker logo

Verify your installation with:

docker --version
docker-compose --version

-----------------------------------------------------

🛒 Cloning the Repository

  • Clone the repository: 
    git clone https://github.com/qgis/QGIS-Changelog-Website.git
  • Check your current directory: 
    pwd
  • The repository path should be <your current directory>/QGIS-Changelog-Website
  • Navigate to the project directory: 
    cd QGIS-Changelog-Website/

-----------------------------------------------------

Pre-commit Hooks

This repository uses pre-commit to automate code quality checks before each commit. To set it up:

  1. Install pre-commit (if not already installed):

    pip install pre-commit

  2. Install the hooks defined in .pre-commit-config.yaml:

    pre-commit install

Now, the configured checks (such as linting and formatting) will run automatically when you commit changes.

-----------------------------------------------------

❄️ Nix

If you use Nix or NixOS, you can set up the development environment with:

nix-shell
./vscode.sh

Note: The Nix shell will soon install all dependencies automatically.

-----------------------------------------------------

⚡️ Quick Start

  • Generate your .env file from the example and update it with your email configuration:

    cd deployment
cp .env.example .env
nano .env  # Edit as needed

  • Build and start the application:

    make build
make devweb

  • Run migrations and load initial data:

    make shell c=devweb
python manage.py migrate
python manage.py loaddata changes/fixtures/initial_data.json
# Exit the shell with Ctrl+D

  • Start the development server:

    make devweb-runserver

Open your browser and visit http://localhost:62202. The default super admin credentials are qgisadmin / qgisadmin.

-----------------------------------------------------

More Information

For detailed instructions, please refer to the README-dev and README-docker files. These documents provide comprehensive information about both development and production environments, similar to the original Projecta application.

-----------------------------------------------------