eclipseapp/skeleton

The Eclipse project base

dev-master 2024-02-10 10:23 UTC

Requires

• php: ^8.2
• ext-gettext: *
• ext-json: *
• eclipseapp/core: dev-master

Requires (Dev)

• eclipseapp/module-template: dev-master
• fakerphp/faker: ^1.9.1
• laravel/pint: ^1.13
• mockery/mockery: ^1.4.4
• nunomaduro/collision: ^7.0
• pestphp/pest: ^2.33
• phpunit/phpunit: ^10.1
• spatie/laravel-ignition: ^2.0

MIT

• DataLinx

• laravel
• Eclipse

README

• About
• Requirements
• Getting started
• Contributing
  • Changelog

About

Eclipse is a PHP app built with Laravel, Livewire and Bootstrap. Its purpose is to offer a solid platform on a modern stack upon which custom web apps can be built. It aims to offer a set of pre-built modules and other generic components which allow a web app for custom project needs to be built quickly and efficiently with little or no boilerplate code.

It's being developed by DataLinx, a company in Slovenia/EU, for use in client and own web projects. It's currently in pre-alpha development stage.

This package serves as a starting point and reference for all Eclipse-based PHP projects.

Requirements

• PHP >= 8.2
  • See the require section in composer.json for required PHP extensions
• MariaDB >= 10.6
• Composer
• For local development:
  • Node.js with npm
  • Although not obligatory, Lando is recommended for setting up the Docker containers. All Eclipse packages already ship with a Lando config file.

Getting started

1. Create a new project with composer:

   composer create-project eclipseapp/skeleton myprojectname -s dev

2. Run npm install in the directory.
3. Run lando start and then lando ssh to enter into the container.
4. Run php artisan eclipse:install and follow the installation procedure 😎

Contributing

If you have some suggestions how to make this package better, please open an issue or even better, submit a pull request.

Should you want to contribute, please see the development guidelines in the DataLinx PHP package template.

Changelog

All notable changes to this project are automatically documented in the CHANGELOG.md file using the release workflow, based on the release-please GitHub action.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

For all this to work, commit messages must follow the Conventional commits specification, which is also enforced by a Git hook.