Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.15 KB

README.md

File metadata and controls

29 lines (19 loc) · 1.15 KB

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 static site is generated with the MKDocs Python package. Therefore having Python 3.7+ installed locally is required to contribue.

To start contributing, follow these steps:

  1. Fork this repository and git clone the repository
  2. Create a new virtual environment using python3 -m venv venv
  3. Activate the virtual environment: source venv/bin/activate
  4. Install the requirements: pip install -r requirements.txt
  5. Edit the documentation and view the output using mkdocs serve
  6. When satisfied, commit your changes and submit the PR to the master branch

Credits