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/

Installation

To install latest version of contributte/webapp-skeleton use Composer.

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

Install using docker

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

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

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

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

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 and enjoy!

Take a look at:

http://localhost:8000.
http://localhost:8000/admin (admin@admin.cz / admin)

Install using docker-compose

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

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

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

3) Run docker-compose up

4) Open http://localhost and enjoy!

Take a look at:

http://localhost.
http://localhost/admin (admin@admin.cz / admin)

Features

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

PHP 8.0+
:package: Packages
- Nette 3+
- Contributte
- Nettrine
:deciduous_tree: 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
:exclamation: Tracy
- Cool error 500 page