https://github.com/PackagePages/LaravelPackage.com

Documentation for LaravelPackage.com: Learn to create Laravel specific PHP packages from scratch, following this open documentation.
https://github.com/PackagePages/LaravelPackage.com

hacktoberfest laravel mkdocs package package-development

Last synced: 12 days ago
JSON representation

Documentation for LaravelPackage.com: Learn to create Laravel specific PHP packages from scratch, following this open documentation.

• Host: GitHub
• URL: https://github.com/PackagePages/LaravelPackage.com
• Owner: PackagePages
• License: mit
• Created: 2019-10-26T22:12:56.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-04T15:18:36.000Z (2 months ago)
• Last Synced: 2024-10-15T07:43:06.146Z (22 days ago)
• Topics: hacktoberfest, laravel, mkdocs, package, package-development
• Homepage: https://laravelpackage.com
• Size: 4.1 MB
• Stars: 493
• Watchers: 10
• Forks: 91
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Support: docs/supporting-new-laravel-versions/laravel-11.md

Awesome Lists containing this project

README

        
# Developing Laravel Packages

This is the repo for the [Laravel Package](https://laravelpackage.com/) 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](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

1. Create a new virtual environment using `python3 -m venv venv`

1. Activate the virtual environment: `source venv/bin/activate`

1. Install the requirements: `pip install -r requirements.txt`

1. Edit the documentation and view the output using `mkdocs serve`

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

## Credits

- [John Braun][link-author]

- [All Contributors][link-contributors]

[link-author]: https://github.com/Jhnbrn90

[link-contributors]: ../../contributors