DocExplorer

Important

This is a collaborative project! We welcome contributions from everyone in the community. Whether you're a seasoned developer or just starting out, your input and contributions are valuable to making this project better for everyone.

Introduction

The DocExplorer website is available at https://docexplorer.dev.

DocExplorer helps you discover random documentation pages from your favorite framework. Click a button, get a random page. It's a simple way to explore documentation you might not have found otherwise.

• Laravel: ~1827 documentation links
• FilamentPHP: ~1576 documentation links
• Livewire: ~502 documentation links

Project Specifications

• Laravel 12
• Livewire 3
• PestPHP 3
• PHP 8.4

Goal

• Make framework documentation exploration fun and engaging
• Help developers discover new features and best practices
• Create a community-driven learning platform
• Support continuous learning and skill development
• Build a welcoming community of contributors
• Encourage knowledge sharing and collaboration
• Foster an inclusive environment for learning and growth
• Create opportunities for developers to improve their skills through real-world contributions
• Build a sustainable open-source project that benefits the entire developer community

Getting Started

Installation

1. Clone the repository:

git clone https://github.com/codewithdennis/docexplorer.git
cd docexplorer/

2. Install dependencies:

composer install
npm install
npm run build

3. Set up environment:

cp .env.example .env
php artisan key:generate

4. Configure your database in .env

5. Run migrations and seeder:

php artisan migrate
php artisan db:seed

6. Start the development server:

php artisan serve
npm run dev

Testing

The project uses Pest PHP for testing. Run tests with:

php artisan test

Code Quality Tools

The project uses several code quality tools to maintain high standards:

• Rector - Automated code refactoring
• Laravel Pint - PHP code style fixer
• PHPStan - Static analysis tool
• PestPHP - Testing framework

You can run all code quality tools in sequence using the composer review command:

composer review

This command will:

1. Run Rector for automated code refactoring
2. Apply Laravel Pint code style fixes
3. Run PHPStan for static analysis
4. Execute all tests with PestPHP

Contributing

To contribute to the project:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Contribution Guidelines

• Follow PSR-12 coding standards
• Write tests for new features
  • If you're unfamiliar with testing or need help, you can create a draft PR and ask for assistance from the community.
• Update documentation as needed
• Use meaningful commit messages
• Keep PRs focused and manageable
• Consider adding support for new frameworks

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

This license ensures that:

• Anyone can contribute to the project
• The project remains open source
• Modifications and improvements must be shared back with the community
• The project cannot be copied and rebranded as a separate commercial product
• All derivative works must also be open source

Acknowledgments

• Laravel - The PHP framework
• Livewire - Full-stack framework for Laravel
• FilamentPHP - Admin panel framework
• All contributors and supporters