README.md

Developing Laravel Packages

This is the repo for the Laravel Package project. A central place to learn how to create a package from scratch.

All provided examples are available as an accompanying example package named "BlogPackage", which you can find and clone here: https://github.com/Jhnbrn90/BlogPackage.

Contributing

Contributions are highly welcomed.

The documentation site is generated using MkDocs, so you’ll need either a local Python setup or Docker to get started.

Option 1 - Local Python setup

To start contributing with a local Python setup, follow these steps:

1. Fork this repository and clone it locally
2. Create a new virtual environment:

   python3 -m venv venv

3. Activate the virtual environment:

   source venv/bin/activate

4. Install the requirements:

   pip install -r requirements.txt

5. Start the local development server:

   mkdocs serve

6. Open http://localhost:8000 in your browser to view the documentation site.

Option 2 - Docker

If you prefer not to install Python and MkDocs locally, you can contribute using Docker:

1. Fork this repository and clone it locally
2. Ensure Docker is installed and running.
3. From the project root, run:

   docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

4. Open http://localhost:8000 in your browser to view the documentation site.

When satisfied, commit your changes and submit the PR to the master branch

Credits

• John Braun
• All Contributors