Kei
66c5c0d2f8
|
5 years ago | |
---|---|---|
app | 5 years ago | |
bootstrap | 5 years ago | |
config | 5 years ago | |
database | 5 years ago | |
public | 5 years ago | |
resources | 5 years ago | |
routes | 5 years ago | |
storage | 6 years ago | |
tests | 5 years ago | |
.editorconfig | 6 years ago | |
.env.example | 6 years ago | |
.gitattributes | 6 years ago | |
.gitignore | 5 years ago | |
LICENSE | 5 years ago | |
artisan | 6 years ago | |
composer.json | 5 years ago | |
composer.lock | 5 years ago | |
package.json | 5 years ago | |
phpunit.xml | 5 years ago | |
readme.md | 5 years ago | |
server.php | 6 years ago | |
webpack.mix.js | 5 years ago | |
yarn.lock | 5 years ago |
readme.md
Newt
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
Requirements
- All requirements by Laravel - PHP >= 7.1.3, Composer and such.
- MySQL or MariaDB.
Quick Start
Installation Instructions
-
Run
composer install
. -
Rename
.env.example
file to.env
or runcp .env.example .env
.Update
.env
to your specific needs. Don't forget to setDB_USERNAME
andDB_PASSWORD
with the settings used behind. -
Run
php artisan key:generate
. -
Run
php artisan migrate --seed
. -
Run
php artisan serve
.After installed, you can access http://localhost:8000 in your browser.
-
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:
- From the projects root folder run
yarn
- Run
yarn dev
oryarn prod
- You can watch assets with
yarn watch
Using NPM:
- From the projects root folder run
npm install
- Run
npm run dev
ornpm 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:
- Fork the repository.
- Hack on a separate topic branch created from the latest
master
. - Commit and push the topic branch.
- Make a pull request.
- Welcome to the club 😎 and thank you for helping out!
License
Newt is an open-sourced software licensed under the MIT license.