A simple, open-source URL shortener app.
· Report Bug
· Request Feature
- Create a shortened link for a target URL
- Access stats of that link
To get a local copy up and running follow these simple steps.
This is an example of how to list things you need to use the software and how to install them.
- PHP >= 7.2.5
- BCMath PHP Extension
- Ctype PHP Extension
- Fileinfo PHP extension
- JSON PHP Extension
- Mbstring PHP Extension
- OpenSSL PHP Extension
- PDO PHP Extension
- Tokenizer PHP Extension
- XML PHP Extension
- SQLite PHP Extension
- Composer
- npm
- Clone url-shortener repo
git clone https://github.com/dafonso/url-shortener.git && cd url-shortener- Install dependencies
npm install && composer install- Copy .env.example file
cp .env.example .env- Create SQLite file
touch database/database.sqlite- Generate a new encryption key for the app
php artisan migrate:fresh- Run Migrations
php artisan migrate:fresh- Run Mix and Serve app
npm run prod && php artisan serve- Access URL Shortener app on http://localhost:8000
php artisan testSee the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Diogo Afonso - @dafonso
Project Link: https://github.com/dafonso/url-shortener