eleazarbr/project-skeleton

Basic template for my projects.

v1.0.0 2023-01-29 16:55 UTC

Requires

• php: ^8.1
• guzzlehttp/guzzle: ^7.2
• inertiajs/inertia-laravel: ^0.6.3
• laravel/framework: ^9.41
• laravel/sanctum: ^3.0
• laravel/tinker: ^2.7
• tightenco/ziggy: ^1.5

Requires (Dev)

• fakerphp/faker: ^1.9.1
• laravel/breeze: ^1.15
• laravel/pint: ^1.0
• laravel/sail: ^1.16.3
• mockery/mockery: ^1.4.4
• nunomaduro/collision: ^6.1
• phpunit/phpunit: ^9.5.10
• spatie/laravel-ignition: ^1.0

MIT

• framework
• laravel
• vue

README

Project Skeleton

A foundational template for all my projects.

Report Bug · Request Feature

Table of Contents

```
1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
```

About The Project

This repository provides a pre-configured template equipped with basic tools for kick-starting any project.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Follow these steps to get a local copy up and running:

Prerequisites

In the future, options for Docker or Laravel Sail will be available. Currently, installation requires a web server like NGINX and the following tools:

• PHP ^8.2
  • Laravel Required PHP Extensions
• Composer
  • Rector (global install optional)
  • PHP Coding Standards Fixer (global install optional)
  • PHPMD - PHP Mess Detector (global install optional)
• Node 16.18
• NPM 8.19
• An SSL setup (needed for Websockets).

Installation

To create a new project, execute:

composer create-project eleazarbr/project-skeleton name

Install JavaScript dependencies:

npm install

Compile assets:

npm run dev

Next, set up your .env file. Basic configurations include:

• App name & URL.
• Database connection and migration: php artisan migrate.
• Mail settings (example: Mailtrap).
• Execute: php artisan storage:link.

Now, you should be able to access the project from your browser.

Usage

The project incorporates LTS versions of Laravel and Vue. Additionally, code fixers and linters are included to ensure coding standards are maintained. Here's a quick rundown:

• Apply rules from the rector.php file: composer rector
• Fix the PHP code: composer php-cs-fixer. (Laravel Pint will be used in the future)
• Run mess detector (optional): composer php-md
• Fix JavaScript code: npm run lint-fix
• Format JavaScript code with Prettier: npm run format
• Test the entire suite: php artisan test

Browser Testing:

• Install Laravel Dusk: php artisan dusk:install.
• Run tests: php artisan dusk.

(back to top)

Roadmap

• Implement Bulma CSS
• Add i18n.
• Replace PHP CS Fixer with Laravel Pint
• Add Docker / Laravel Sail support.

For a complete list of proposed features and known issues, visit the open issues.

(back to top)

Contributing

Your contributions help make the open-source community a space for learning, inspiration, and creativity. Any contributions are greatly appreciated.

If you have suggestions for improvements, please fork the repo and create a pull request or open an issue tagged as "enhancement". Don't forget to star the project!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

(back to top)

License

This project is distributed under the MIT License. For more information, please refer to the LICENSE.txt file.

(back to top)

Contact

Eleazar Resendez - @eleazarbr - [e-mail]

Project Link: https://github.com/eleazarbr/project-skeleton

(back to top)