https://github.com/pascalallen/astral

A lightweight SDK for PHP web development. Fork me. Designed following the SOLID principles, CQRS, and DDD.
https://github.com/pascalallen/astral

docker docker-compose mysql nginx php react sass symfony typescript

Last synced: 7 days ago
JSON representation

A lightweight SDK for PHP web development. Fork me. Designed following the SOLID principles, CQRS, and DDD.

• Host: GitHub
• URL: https://github.com/pascalallen/astral
• Owner: pascalallen
• Created: 2021-07-06T19:20:49.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-08T22:10:59.000Z (7 months ago)
• Last Synced: 2024-04-08T23:30:39.602Z (7 months ago)
• Topics: docker, docker-compose, mysql, nginx, php, react, sass, symfony, typescript
• Language: PHP
• Homepage:
• Size: 104 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Astral

![Docker Compose Build Status](https://github.com/pascalallen/Astral/workflows/Docker%20Compose/badge.svg)

![PHP Build Status](https://github.com/pascalallen/Astral/workflows/PHP/badge.svg)

Minimal PHP web development starter kit. Designed from scratch following the SOLID principles, the CQRS and ADR

patterns, and DDD. Features include:

- Fully containerized application

- Adminer DB GUI

- Build Pipelines for GitHub and BitBucket

- Shell scripts for Composer, Doctrine, Docker, PHP, Logs, and PHPUnit

- Command Bus

- Event Dispatcher

- Doctrine ORM

- Logger w/ streams to Papertrail and php://stdout

- (Coming Soon) Worker Queue

- DI Container

- Sample repository and interface

- Sample command and handler

- Sample event and listener

- (Coming soon) Sample action and responder

- (Coming Soon) Sample query service dependency

- Sample aggregates

- (Coming Soon) Routing

- (Coming Soon) Twig template engine

- (Coming Soon) API

- (Coming Soon) React/TypeScript integration

- Code style config file

- EditorConfig file

## Prerequisites

- [Docker](https://www.docker.com/)

- [Docker Compose](https://docs.docker.com/compose/)

## Development Environment Setup

### Clone Repository

$ `cd  && git clone [email protected]:pascalallen/astral.git`

### Add Entry to `/etc/hosts` File

$ `127.0.0.1       local.astral.com`

### Copy & Modify .env File

$ `cp .env.example .env`

### Bring Up Environment

$ `bin/up`

### Tail Logs

$ `bin/logs -f`

### Install Composer Dependencies

$ `bin/composer install`

### Create Schema

$ `bin/doctrine orm:schema-tool:create`

### Run Unit Tests

$ `bin/phpunit`

### Take Down Environment

$ `bin/down`

#### Code Style

Code style configuration file for PhpStorm is available for import: [CodeStyle.xml](etc/build/CodeStyle.xml)

[Copying Code Style Settings](https://www.jetbrains.com/help/phpstorm/copying-code-style-settings.html)