Contributte

Contributte Webapp-skeleton

github.com/contributte/webapp-skeleton
packagist.org/packages/contributte/webapp-skeleton

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

# Goal

Main goal is to provide best prepared starter-kit project for Nette developers.

Focused on:

  • PHP 8.1+
  • nette/* packages
  • Doctrine ORM via nettrine/*
  • Symfony components via contributte/*
  • codestyle checking via CodeSniffer and contributte/qa
  • static analysing via phpstan and contributte/phpstan
  • unit / integration tests via Nette Tester and contributte/tester

# Demo

https://examples.contributte.org/webapp-skeleton/ (opens new window)

# Installation

To install latest version of contributte/webapp-skeleton use Composer (opens new window).

composer create-project -s dev contributte/webapp-skeleton acme
1

# Install using docker (opens new window)

  1. At first, use composer to install this project.

    composer create-project -s dev contributte/webapp-skeleton
    1

  2. After that, you have to setup Postgres >= 10 database. You can start it manually or use docker image dockette/postgres:12.

    docker run -it -p 5432:5432 -e POSTGRES_PASSWORD=webapp -e POSTGRES_USER=webapp dockette/postgres:12
    1

    Or use make task, make docker-postgres.

  3. Custom configuration file is located at config/local.neon. Edit it if you want.

    Default configuration should look like:

    # Host Config
parameters:
    # Database
    database:
        host: localhost
        dbname: webapp
        user: webapp
        password: webapp
    1
    2
    3
    4
    5
    6
    7
    8

  4. Ok database is now running and application is configured to connect to it. Let's create initial data.

    Run NETTE_DEBUG=1 bin/console migrations:migrate to create tables. Run NETTE_DEBUG=1 bin/console doctrine:fixtures:load --append to create first user(s).

    Or via task make build.

  5. Start your devstack or use PHP local development server.

    You can start PHP server by running php -S localhost:8000 -t www or use prepared make task make dev.

  6. Open http://localhost (opens new window) and enjoy!

    Take a look at:

# Install using docker-compose (opens new window)

  1. At first, use composer to install this project.

    composer create-project -s dev contributte/webapp-project
    1

  2. Modify config/local.neon and set host to database

    Default configuration should look like this:

    # Host Config
parameters:
    # Database
    database:
        host: database
        dbname: webapp
        user: webapp
        password: webapp
    1
    2
    3
    4
    5
    6
    7
    8

  3. Run docker-compose up

  4. Open http://localhost (opens new window) and enjoy!

    Take a look at:

# Features

Here is a list of all features you can find in this project.

  • PHP 8.0+
  • 📦 Packages
    • Nette 3+
    • Contributte
    • Nettrine
  • 🌳 Structure
    • app
      • config - configuration files
        • env - prod/dev/test environments
        • app - application configs
        • ext - extensions configs
        • local.neon - local runtime config
        • local.neon.dist - template for local config
      • domain - business logic and domain specific classes
      • model - application backbone
      • modules - Front/Admin module, presenters and components
      • resources - static content for mails and others
      • ui - UI components and base classes
      • bootstrap.php - Nette entrypoint
    • bin - console entrypoint (bin/console)
    • db - database files
      • fixtures - PHP fixtures
      • migrations - migrations files
    • docs - documentation
    • var
      • log - runtime and error logs
      • tmp - tmp files and cache
    • tests - test engine and unit/integration tests
    • vendor - composer's folder
    • www - public content
  • ❗️ Tracy
    • Cool error 500 page

# Notable changes

# Composer packages

Take a detailed look 👀 at each single package.

Doctrine

Dev

# Screenshots

admin@admin.cz / admin

# Development

See how to contribute (opens new window) to this package.

This package is currently maintaining by these authors.

Consider to support (opens new window) contributte development team. Also thank you for using this project.