Contributte Componette-site

Componette

Addons, extensions & components portal for Nette Framework with smooth searching and categorization.

Website 🚀 componette.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @xf3l1x


# Requirements

  • PHP 7.4+
  • NodeJS 12+
  • Caddy 0.11+
  • MariaDB 10.3+
  • Docker [optionally]

# How to develop

# Backend

  • Clone this repo (git@github.com:contributte/componette-site.git).
  • Rename app/config/config.local.sample to config.local.neon and fill parameters (database, github token, etc).
  • Run composer install.
  • Run migration via bin/console migrations:continue follow steps.
  • Start webserver NETTE_DEBUG=1 php -S 0.0.0.0:8000 -t www

# Frontend

  • Run npm install
  • Run gulp deploy (it compiles once all JS/CSS files)

For developing you can use gulp watch, it's monitor every CSS and JS files in <project>/www/assets.

# How to contribute

I very appreciate you contributing work, these tools keep on eye and help me to keep a high code standard.

# Automated tasks

This project has a few tasks you should fired before you prepare PR.

  • Quality Assurance - checks PHP syntax errors and codestyle
make qa
1
  • Nette\Tester - runs unit & integration tests
make tests
1
  • PHPstan - runs static analyse
make phpstan
1