Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 1.84 KB

README.md

File metadata and controls

79 lines (52 loc) · 1.84 KB
Raw

URL Short

URL Short is a URL shortener web application based on the AdonisJS Framework. It is an open-source and easy-to-use URL shortener. It allows you to host your own URL shortener, and gives you many useful features.

Warning: URL Short is still in development, constantly being optimized and isn't still stable enough to be used in production environments.

Features

  • URL Shortener
  • Customized short URL's(ex: example.com/adonis)
  • QR code generator
  • Simple Interface
  • User & Admin Dashboard

Screenshots

Home Stats Login Dashboard

Prerequisites

  • Node.js >= 8.0.0
  • npm >= 3.0.0
  • MySQL or MariaDB
  • adonis-cli

Getting Started

Via Cloning The Repository

# if you don't have AdonisJS CLI
npm i -g @adonisjs/cli

# Change directory
cd adonis-url-short

# Install Dependencies
npm install

# Copy .env.example to .env and update it to your specific needs. Don't forget to set DB_USER and DB_PASSWORD with the settings used behind.
cp .env.example .env

# Generate App Key
adonis key:generate

# Run migrations
adonis migration:run

# Seed Database
adonis seed

# Serve
adonis serve --dev

Login Details

Email Name Password Role
admin@test.com Admin admin@123 Administrator
user@test.com User user@123 User

Compiling assets

  1. npm install

  2. npm run dev or npm run production

    You can watch assets with npm run watch

Contributing

Thank you for considering contributing to URL Short.

License

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