contributte / componette-site

:loop: Addons, plugins, components and extensions (@componette :heart: @nette)

Home Page:https://componette.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Componette

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

Website πŸš€ componette.org | Contact πŸ‘¨πŸ»β€πŸ’» f3l1x.io | Twitter 🐦 @xf3l1x


Requirements

  • PHP 8.1+
  • NodeJS 18+
  • 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
  • Nette\Tester - runs unit & integration tests
make tests
  • PHPstan - runs static analyse
make phpstan

About

:loop: Addons, plugins, components and extensions (@componette :heart: @nette)

https://componette.org

License:MIT License


Languages

Language:PHP 56.5%Language:Latte 21.4%Language:Less 10.5%Language:CSS 5.9%Language:JavaScript 3.1%Language:TypeScript 1.7%Language:Makefile 0.5%Language:Shell 0.3%Language:Dockerfile 0.2%