URL shortener web application based on the Laravel PHP Framework.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Kei 66c5c0d2f8
2019
5 years ago
app Rename the project 5 years ago
bootstrap rev-181121 5 years ago
config Rename the project 5 years ago
database Rename the project 5 years ago
public Merge pull request #28 from ppshobi/cleanup-project-building-process 5 years ago
resources Rename the project 5 years ago
routes rev-181108 5 years ago
storage rev-180913 6 years ago
tests Rename the project 5 years ago
.editorconfig rev-180907 6 years ago
.env.example Initial commit 6 years ago
.gitattributes Initial commit 6 years ago
.gitignore rev-181201 5 years ago
LICENSE 2019 5 years ago
artisan Initial commit 6 years ago
composer.json rev-181121 5 years ago
composer.lock Bump laravel/framework from 5.7.16 to 5.7.19 (#75) 5 years ago
package.json Bump bootstrap from 4.1.3 to 4.2.1 (#80) 5 years ago
phpunit.xml rev-181027 5 years ago
readme.md Rename the project 5 years ago
server.php Apply fixes from StyleCI 6 years ago
webpack.mix.js Rename the project 5 years ago
yarn.lock [Security] Bump webpack-dev-server from 3.1.10 to 3.1.14 (#81) 5 years ago

readme.md

Newt

MadeWithLaravel.com shield StyleCI shield GitHub license

Warning: This software is still in development, so we dont 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-sourced software licensed under the MIT license.