Free, open-source, self-hosted URL shortener web application based on the Laravel PHP Framework.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Attribute casting for 'email_verified_at' on User model stub Feb 4, 2019
bootstrap rev-181121 Nov 22, 2018
config version Feb 7, 2019
database Use Str::random() instead of str_random() Feb 3, 2019
public
resources Rename the project Dec 23, 2018
routes rev-181108 Nov 8, 2018
storage rev-180913 Sep 13, 2018
tests Rename the project Dec 23, 2018
.editorconfig rev-180907 Sep 7, 2018
.env.example Initial commit Aug 6, 2018
.gitattributes Initial commit Aug 6, 2018
.gitignore rev-181201 Dec 1, 2018
LICENSE 2019 Jan 4, 2019
artisan Initial commit Aug 6, 2018
composer.json rev-181121 Nov 22, 2018
composer.lock Bump laravel/framework from 5.7.25 to 5.7.26 Feb 13, 2019
package.json Bump sass from 1.15.3 to 1.16.0 Jan 17, 2019
phpunit.xml rev-181027 Oct 27, 2018
readme.md fix typo Feb 6, 2019
server.php Apply fixes from StyleCI Aug 26, 2018
webpack.mix.js
yarn.lock Bump laravel/framework from 5.7.25 to 5.7.26 Feb 13, 2019

readme.md

Newt

MadeWithLaravel.com shield StyleCI shield GitHub license

Warning: This software is still in development, so we don’t recommend you run it on a production site.

Newt is a free, open-source and easy-to-use but powerful URL shortener. It allows you to host your own URL shortener, and gives you many useful features.

Features

  • URL Shortener.
  • Customized short URL's(ex: example.com/laravel).
  • QR code generator for each short link.
  • Sortable list of shortened URLs.
  • Written in PHP and Laravel 5.7.
  • Datatables with server-side processing.
  • Modern and simple interface.
  • Made with ❤️ & ☕️.

Screenshots

screenshot screenshot screenshot screenshot

Requirements

Quick Start

Installation Instructions

  1. Run composer install.

  2. Rename .env.example file to .env or run cp .env.example .env.

    Update .env to your specific needs. Don't forget to set DB_USERNAME and DB_PASSWORD with the settings used behind.

  3. Run php artisan key:generate.

  4. Run php artisan migrate --seed.

  5. Run php artisan serve.

    After installed, you can access http://localhost:8000 in your browser.

  6. Login

    Email Username Password Access
    admin@newt.test admin admin Admin Access
    user@newt.test user user User Access

Compiling assets with Laravel Mix

Using Yarn:

  1. From the projects root folder run yarn
  2. Run yarn dev or yarn prod
  • You can watch assets with yarn watch

Using NPM:

  1. From the projects root folder run npm install
  2. Run npm run dev or npm run prod
  • You can watch assets with npm run watch

Contributing

Any useful suggestion and PR are welcomed. If you would like to contribute, please do the following:

  1. Fork the repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Welcome to the club 😎 and thank you for helping out!

License

Newt is an open-source software licensed under the MIT license.