https://github.com/democrito88/demovel

Library that creates a structure of a simple PHP project on MVC achitecture.
https://github.com/democrito88/demovel

composer library mvc-architecture php symfony

Last synced: 25 days ago
JSON representation

Library that creates a structure of a simple PHP project on MVC achitecture.

• Host: GitHub
• URL: https://github.com/democrito88/demovel
• Owner: democrito88
• License: mit
• Created: 2024-08-13T03:02:46.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-28T02:29:19.000Z (2 months ago)
• Last Synced: 2024-09-30T22:40:56.106Z (about 1 month ago)
• Topics: composer, library, mvc-architecture, php, symfony
• Language: PHP
• Homepage:
• Size: 36.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Demovel

![Version](https://img.shields.io/badge/v0.1.0-fed000?style=for-the-badge)

![License](https://img.shields.io/badge/MIT-0ac18e?style=for-the-badge)

![PHP](https://img.shields.io/badge/php-%23777BB4.svg?style=for-the-badge&logo=php&logoColor=white)

![Symfony](https://img.shields.io/badge/symfony-%23000000.svg?style=for-the-badge&logo=symfony&logoColor=white)

![Composer](https://img.shields.io/badge/composer-%23ff6347.svg?style=for-the-badge)

![Dependencies](https://img.shields.io/badge/dependencies-11-%23af0000.svg?style=for-the-badge)

Library that create a structure of a simple PHP project on MVC achitecture. It uses Symfony libraries as dependencies such as Doctrine.

### Usage

#### Create a new project

To create a new project, install this package and run the command:

```

composer install

./bin/console create:new 

```

It will create a project with the following structure:

```

root-folder

  ├──public

  |  └──index.php

  ├──src

  |  ├──Provider

  |  |  └──EntityServiceProvider.php

  |  ├──Controller

  |  |  ├──InterfaceController.php

  |  |  ├──Controller.php

  |  |  ├──UserController.php

  |  |  └──TokenController.php

  |  └──Entity

  |     ├──Entity.php

  |     ├──User.php

  |     └──Token.php

  ├──routes

  |  ├──router.php

  |  └──routes.php

  ├──.env

  └──.htaccess

```

#### Create migration basic structure

```

./bin/console attach:migration

```

This command will create the basic structure for create and run migration classes as it follows:

```

root-folder

  └──database

     └──migrations

        ├──CreateTable.php

        ├──CreateUsersTable.php

        └──runMigrations.php

```

All migration classes must extend CreateTable class and be mentioned in runMigrations.php script.

#### Create seeding basic structure

```

./bin/console attach:seeding

```

This command will create the basic structure for create and run seeding classes as it follows:

```

root-folder

  └──database

     └──seed

        ├──Seeder.php

        ├──UsersSeeder.php

        └──runSeeders.php

```

All seedeing classes must extend Seeder class and be mentioned in runSeeders.php script.

#### Create a mail class

```

./bin/console attach:mail

```

It will create the Sender.php file inside a Email folder as it follows:

```

root-folder

  └──src

     └──Email

        └──Seeder.php

```

This package uses [PHPMailer](https://github.com/PHPMailer/PHPMailer) to send an email.

#### Create new Entity

```

.bin/console new:entity 

```

This command will create a new Entity class in the ```src/Entity``` directory. You just need to pass the name parameter.

This projects uses [Dorctrine ORM annotations](https://www.doctrine-project.org/projects/doctrine-orm/en/3.2/reference/basic-mapping.html) in its Entities.

#### Create new Controller

```

.bin/console new:controller 

```

This command will create a new Controller class in the ```src/Controller``` directory. You just need to pass the name parameter.

### Author

[Demócrito d'Anunciação](https://github.com/democrito88)