Compagnon

An application that will bring together the tools developers need in one place!

Stop searching for "uuid v4", "compress pdf", "compress img", "convert json to yaml", etc. on Google

The Compagnon app will bring these kinds of tools together in one place, so you won't have to go online every time.

Download (MacOS, Windows, Linux)

Coming soon

How to install

After cloning the repository, run the following commands in your terminal:

cp .env.example .env
cp external-modules/composer.json.example external-modules/composer.json
cp external-modules/composer.lock.example external-modules/composer.lock
touch database/database.sqlite
touch database/database.testing.sqlite

# OR

make init.app

With composer and npm

Follow these steps to install and set up Compagnon on your local machine:

• Navigate to the project directory: cd compagnon
• Install dependencies:

    make composer_ci
    make npm_ci

• Generate a new application key:

  php artisan key:generate

• Build the application:

  npm run build

With docker

docker compose up -d
docker compose exec laravel.test make composer_ci
docker compose exec laravel.test php artisan key:generate
docker compose exec laravel.test make npm_ci
docker compose exec laravel.test npm run build

Access Compagnon in your web browser at http://localhost/

Next steps

• i18n support
• Add testing tools for PHP and Javascript, add tests
• Add a documentation for Compagnon
• Remove default views
• Add stubs for modules
• Add a documentation for modules
• Add vitest for unit tests
• Update the UI layout
• Add required modules as Dashboard and Settings
• Support NativePHP
• Create more modules

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details.

License

Compagnon is open-source software licensed under the MIT license (see our LICENSE file).

Credits

• NativePHP
• Laravel
• Laravel Modules
• Inertia.js
• React
• Tailwind CSS
• And more...

Thanks to all contributors!