bootgly/bootgly.console

The Bootgly Console template.

dev-main 2024-05-01 14:47 UTC

Requires

• php: ^8.2
• bootgly/bootgly: dev-main
• bootgly/bootgly-console: dev-main

MIT

• Rodrigo Vieira

• framework
• php
• cli
• template
• console
• bootgly

README

Bootgly.Console template

Bootgly Console Workables template

You should use this repository to start develop your CLI Apps.

This repository serves as a template (starter kit) for you to start developing using the Bootgly Console, which is a part of the Bootgly PHP Framework.

🧩 Templating

Option 1) Using Composer

If you prefer using Composer to manage your PHP dependencies, follow the steps below to initialize the Bootgly Console template repository:

create-project command

To create a new project using the Bootgly Console template and Composer's create-project command, follow these steps:

1. Open your terminal.
2. Run the following command to create a new project based on the Bootgly Console template:

composer create-project bootgly/bootgly.console bootgly.console

Replace bootgly.console with the desired name of your project directory.

Composer will download the Bootgly Console template and its dependencies, and create the project structure for you.

Option 2) Using Git

Git init from template

To get started with the Bootgly Console template repository on GitHub, follow the steps below:

1. Navigate to the main page of the Bootgly Console template repository on GitHub.
2. Click on the "Use this template" button located near the top-right corner of the repository page:
3. On the "Create a new repository" page, provide a name for your new repository.
4. Optionally, add a description and choose the visibility and permissions for your repository.
5. Click on the "Create repository from template" button to create your new repository based on the Bootgly Console template.
6. Clone your repository created from the template.

Initialize and update Submodules

Git submodules are a useful feature that allows you to include one Git repository inside another. In the context of your Bootgly Console template, we can use submodules to include any bootable repository (bootgly-*) in your project. This tutorial will guide you through the process of using Git submodules in your Bootgly Console template project.

1. Open your terminal or command prompt.
2. Navigate to your cloned Bootgly Console template project directory.
3. To init the submodules, use the following commands:

git submodule update --init --recursive

🔜 Next Steps

Once you have initialized your Bootgly Console template repository either using GitHub or Composer, you need to boot the resource dirs to start developing!

Type in your terminal the command:

php bootgly boot --resources

Now you're ready to go! Here are suggestions for next steps:

1. Review the Bootgly documentation to understand the features and capabilities of the Bootgly CLI.
2. Check all boot files in the resource directory projects/: *.boot.php.
3. Test your Console project locally to ensure it works as expected. You can use the provided testing tools and utilities included in the Bootgly (check bootgly test command).
4. Add any additional dependencies or libraries your application requires to the composer.json file and install them using Composer.
5. Document your CLI project by updating this README.md file and providing instructions on how to use and configure your project.
6. Once you are ready, consider publishing your Console project to Packagist to make it available to others.

That's it! You now have a solid foundation for develop your CLI/Console project using the Bootgly Console.

Happy coding!

📃 License

The Bootgly PHP Framework is open-sourced software licensed under the MIT license.