planette/forest-project

This package is abandoned and no longer maintained. The author suggests using the contributte/apitte-skeleton package instead.

🎁 API / REST API / JSON API / PSR-7 / Middlewares project skeleton based on Nette Framework (@nette), Apitte (@apitte), Doctrine (@nettrine) and Contributte (@contributte) libraries by @f3l1x.

Installs: 14 589

Dependents: 0

Suggesters: 0

Security: 0

Stars: 31

Watchers: 3

Forks: 14

Open Issues: 5

Type:project

dev-master 2021-10-13 01:08 UTC

This package is auto-updated.

Last update: 2021-10-13 01:08:36 UTC


README

68747470733a2f2f62616467656e2e6e65742f6769746875622f636865636b732f636f6e74726962757474652f6170697474652d736b656c65746f6e2f6d6173746572 68747470733a2f2f62616467656e2e6e65742f636f766572616c6c732f632f6769746875622f636f6e74726962757474652f6170697474652d736b656c65746f6e 68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f646d2f636f6e74726962757474652f6170697474652d736b656c65746f6e 68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f762f636f6e74726962757474652f6170697474652d736b656c65746f6e

68747470733a2f2f62616467656e2e6e65742f7061636b61676973742f7068702f636f6e74726962757474652f6170697474652d736b656c65746f6e 68747470733a2f2f62616467656e2e6e65742f6769746875622f6c6963656e73652f636f6e74726962757474652f6170697474652d736b656c65746f6e 68747470733a2f2f62616467656e2e6e65742f62616467652f737570706f72742f6769747465722f6379616e 68747470733a2f2f62616467656e2e6e65742f62616467652f737570706f72742f666f72756d2f79656c6c6f77 68747470733a2f2f62616467656e2e6e65742f62616467652f73706f6e736f722f646f6e6174696f6e732f463936383534

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

68747470733a2f2f6170692e6d6963726f6c696e6b2e696f3f75726c3d68747470732533412532462532466578616d706c65732e636f6e74726962757474652e6f72672532466170697474652d736b656c65746f6e253246266f7665726c61792e62726f777365723d6c696768742673637265656e73686f743d74727565266d6574613d66616c736526656d6265643d73637265656e73686f742e75726c

Goal

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

Focused on:

  • latest PHP 8.0
  • nette/* packages
  • build PSR-7 API via apitte/*
  • Doctrine ORM via nettrine/*
  • Symfony components via contributte/*
  • codestyle checking via CodeSniffer and ninjify/*
  • static analysing via phpstan
  • unit / integration tests via Nette Tester and ninjify/*

You can try it out yourself either by running it with docker, or more easily with docker-compose.

Demo

https://examples.contributte.org/apitte-skeleton/

Install with docker

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

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

    docker run -it -p 5432:5432 -e POSTGRES_PASSWORD=apitte -e POSTGRES_USER=apitte postgres:10

    Or use make task, make loc-postgres.

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

    Default configuration should look like:

    # Host Config
    parameters:
    
    	# Database
    	database:
    		host: localhost
    		dbname: apitte
    		user: apitte
    		password: apitte
  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 loc-api.

  6. Open http://localhost and enjoy!

    Take a look at:

Install with docker compose

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

    composer create-project -s dev contributte/apitte-skeleton
    
  2. Modify app/config/config.local.neon and set host to database

    Default configuration should look like this:

    # Host Config
    parameters:
    
    	# Database
    	database:
    		host: database
    		dbname: apitte
    		user: apitte
    		password: apitte
  3. Run docker-compose up

  4. Open http://localhost and enjoy!

    Take a look at:

(Optional) REST API documentation

Since we have OpenAPI specification available at /api/public/v1/openapi/meta you just need to add UI for it (e.g. to www/doc directory or as a standalone application).

Available options are:

Features

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

  • PHP 8.0+
  • 📦 Packages
    • Nette 3.0
    • Apitte
    • Contributte
    • Nettrine
  • 🌳 Structure
    • app
      • config - configuration files
        • env - prod/dev/test environments
        • app - application configs
        • ext - extensions configs
        • config.local.neon - local runtime config
        • config.local.neon.dist - template for local config
      • domain - business logic and domain specific classes
      • model - application backbone
      • module - API module
      • resources - static content for mails and others
      • bootstrap.php - Nette entrypoint
    • bin - console entrypoint (bin/console)
    • db - database files
      • fixtures - PHP fixtures
      • migrations - migrations files
    • docs - documentation
    • log - runtime and error logs
    • temp - temp files and cache
    • tests - test engine and many cases
      • tests/cases/E2E - PhpStorm's requests files (api.http)
      • tests/cases/Integration
      • tests/cases/Unit
    • vendor - composer's folder
    • www - public content
  • ❗ Tracy
    • Cool error 500 page

Composer packages

Take a detailed look 👀 at each single package.

Apitte

Nettrine

Nette

Symfony

Demo

Development

See how to contribute to this package.

This package is currently maintaining by these authors.

538058?v=3&s=80

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