price2performance/sandbox

Sandbox, default project structure for Price2Performance

dev-main 2023-09-05 07:39 UTC

Requires

• php: >= 8.2
• beberlei/doctrineextensions: ^1.3
• contributte/console: ^0.9.3
• latte/latte: ^3.0
• nette/application: ^3.1
• nette/bootstrap: ^3.2
• nette/caching: ^3.2
• nette/database: ^3.1
• nette/di: ^3.1
• nette/forms: ^3.1
• nette/http: ^3.2
• nette/mail: ^4.0
• nette/robot-loader: ^4.0
• nette/security: ^3.1
• nette/utils: ^4.0
• nettrine/annotations: ^0.8.1
• nettrine/cache: ^0.4.1
• nettrine/dbal: ^0.9.0@dev
• nettrine/extensions-atlantic18: ^0.6.0
• nettrine/fixtures: ^0.7.1
• nettrine/migrations: ^0.9.1
• nettrine/orm: ^0.9.0@dev
• phpseclib/phpseclib: ^3.0
• tracy/tracy: ^2.9

Requires (Dev)

• nette/tester: ^2.4

proprietary

README

This is a simple skeleton application for all our projects.

Requirements

• Requires PHP 8.2 and Docker

Installation

The best way to install Sandbox is using Composer. To install in the current folder, use command:

composer create-project price2performance/sandbox .

Make directories temp/ and log/ writable.

Then replace all sandbox occurence with the name of your project. In PhpStorm, you can use CTRL+SHIFT+R to rename all occurences:

• sandbox for project in composer.json
• Sandbox\\ for Project\\ in composer.json
• sandbox for project in .docker folder
• Price2Performance\Sandbox with Price2Performance\Project in all files in app/, tests/, bin/ and config/ folders
• Sandbox for Project in the filename of app/Model/ORM/Entity/xml/Price2Performance.Sandbox.Model.ORM.Entity.User.dcm.xml

Use the real name of your project, not project.

Web Server Setup

Run .docker/up.bat in terminal. On Linux or Mac, run each line from .docker/up.bat manually in Terminal, or create your own .docker/up.sh instead.

In case of ports conflicts, either kill the blocking application (usually Apache) OR modify .docker/docker-composer.yml on these lines:

    ports:
      - 8085:80
      - 4435:443

Choose appropriate ports for you.

Setting up secure connection on localhost

Open browser and type https://localhost (or https://localhost:4435 if you modified the port settings above).

If your browser complains about unsecure connections, you have 2 options:

1. either bypass this error message and tell him to continue anyway (the exact method differs browser from browser)
2. or set out root CA certificate (located at config/rootCA.pem) as trusted according to this article: https://phpfashion.com/jak-zprovoznit-https-na-localhost#toc-uverime-certifikatu

Detailed instructions for Mac: https://tosbourn.com/getting-os-x-to-trust-self-signed-ssl-certificates/, for Windows: https://www.thewindowsclub.com/manage-trusted-root-certificates-windows

Running tests

To run tests, type in the command line:

docker exec project vendor/bin/tester tests -C

Composer update on branch changing

Every time you change the git branch (e.g. from stage2 to master or back again), you have to update vendor directory of composer by following command:

docker exec project composer update

PHPMyAdmin

PHPMyAdmin is available at http://localhost:8080.