Laravel-UrlShortener
A Laravel URL Shortener package that provides URL redirects with optionally protected URL password, URL expiration, open limits before expiration, ability to set feature activation dates, click tracking, custom vanity identifiers, event dispatching, and soft delete/restore out of the box for your Laravel applications.
File Explorer
Download Latest Version (.zip)- dependency-review.yml
- fix-php-code-style-issues.yml
- phpunit.yml
- logo.png
- Upgrading-to-3.x-from-2.x.md
- AttemptProtected.php
- ShortUrlRedirect.php
- ClickQueryBuilder.php
- BaseOption.php
- WithActivation.php
- WithDomain.php
- WithExpiration.php
- WithOpenLimit.php
- WithOwnership.php
- WithPassword.php
- WithTracing.php
- UrlBuilder.php
- UrlBuilderInterface.php
- UrlBuilderOptionInterface.php
- DomainResolverInterface.php
- ShortUrlClicked.php
- ShortUrlCreated.php
- ShortUrlExpired.php
- ClickRepositoryException.php
- ClickServiceException.php
- DomainResolutionException.php
- FilterClicksStrategyException.php
- RateLimitExceededException.php
- TracingRepositoryException.php
- UrlBuilderException.php
- UrlRepositoryException.php
- UrlServiceException.php
- UtilityServiceException.php
- ResolveDomain.php
- ShortUrl.php
- ShortUrlClick.php
- ShortUrlDomain.php
- ShortUrlLocation.php
- ShortUrlOutcome.php
- ShortUrlOwnership.php
- ShortUrlTracing.php
- ClickRepository.php
- LocationRepository.php
- TracingRepository.php
- UrlRepository.php
- ClickService.php
- DomainResolver.php
- UrlService.php
- UrlValidator.php
- UtilityService.php
- AbstractFilter.php
- BatchFilter.php
- IdentifierFilter.php
- OutcomeFilter.php
- OwnershipFilter.php
- StatusFilter.php
- TracingCampaignFilter.php
- TracingContentFilter.php
- TracingIdFilter.php
- TracingMediumFilter.php
- TracingSourceFilter.php
- TracingTermFilter.php
- FilterClicksStrategy.php
- NonPublishableHasFactory.php
- Ownerable.php
- PublishableHasFactory.php
- ShortUrlHelper.php
- location.php
- urlshortener.php
- 2022_08_03_193744_create_short_urls_table.php
- 2022_08_05_163744_create_short_url_clicks_table.php
- 2022_08_05_163744_create_short_url_locations_table.php
- 2022_08_05_163744_create_short_url_outcomes_table.php
- 2022_08_06_163744_create_short_url_outcome_filler_table.php
- 2022_08_06_193744_create_short_ownership_table.php
- 2022_09_06_163744_create_short_url_tracings_table.php
- 2024_01_15_000000_add_domain_to_short_urls_table.php
- 2024_01_15_000001_create_short_url_domains_table.php
- protected.blade.php
- routes.php
- UrlShortenerServiceProvider.php
- DemoOwnerFactory.php
- ShortUrlClickFactory.php
- ShortUrlFactory.php
- ShortUrlLocationFactory.php
- ShortUrlOwnershipFactory.php
- ShortUrlTracingFactory.php
- AttemptProtectedTest.php
- CustomPrefixRouteTest.php
- MultiDomainTest.php
- ShortUrlBasicTest.php
- ShortUrlClickTest.php
- ShortUrlRedirectFailureTest.php
- 2022_08_07_193744_create_demo_owner_table.php
- DemoOwner.php
- VanityIdentifierTest.php
- ShortUrlEventsTest.php
- ResolveDomainTest.php
- ClickRepositoryTest.php
- LocationRepositoryTest.php
- TracingRepositoryTest.php
- UrlRepositoryTest.php
- ClickServiceTest.php
- DomainResolverTest.php
- RateLimitingTest.php
- UrlServiceDeleteRestoreTest.php
- UrlServiceTest.php
- UrlValidatorTest.php
- UtilityServiceTest.php
- FilterClicksStrategyTest.php
- ShortUrlHelperTest.php
- UrlShortenerServiceProviderTest.php
- TestCase.php
- TestUrlShortenerServiceProvider.php
- .gitattributes
- .gitignore
- CHANGELOG.md
- composer.json
- composer.lock
- CONTRIBUTING.md
- docker-compose.yml
- Dockerfile
- LICENSE
- phpunit.xml
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/YorCreative/Laravel-UrlShortener
Downloads the entire project code from GitHub to your computer.
cd Laravel-UrlShortener
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. PHP (Composer)
EasyPrerequisites
composer require yorcreative/laravel-urlshortener
Type this command into your terminal and run it.
composer test
Type this command into your terminal and run it.
Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)