contributte/doctrine-skeleton

Nette and Doctrine project skeleton. Using Doctrine (@nettrine) and Contributte (@contributte) libraries by @f3l1x.

dev-master 2024-10-29 16:11 UTC

README

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/doctrine-skeleton/

Installation

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

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

Install using docker

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

    composer create-project -s dev contributte/doctrine-skeleton
    
  2. After that, you have to setup Postgres >= 12 database. You can start it manually or use docker image dockette/postgres:12.

    docker run -it -p 5432:5432 -e POSTGRES_PASSWORD=doctrine -e POSTGRES_USER=doctrine 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: doctrine
            user: doctrine
            password: doctrine
  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:8000 and enjoy!

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: contributte
            user: contributte
            password: contributte
  3. Run docker-compose up

  4. Open http://localhost and enjoy!

    Take a look at:

Composer packages

Take a detailed look 👀 at each single package.

Doctrine

Dev

Screenshots

Development

See how to contribute to this package.

This package is currently maintaining by these authors.

Consider to support contributte development team. Also thank you for using this project.