Url Shortener

Laravel - Vue url-shortener with login System
· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

screencast-nimbus-capture-2022.12.28-16_57_28.webm

Plan selection for user and active in-active urls demo:

screencast-nimbus-capture-2022.12.30-17_55_18.webm

This project is an admin panel that includes user login functionality. It allows users to create short URLs using Vue 3 in the frontend, along with Pinia store for state management and services to make API calls for inserting, updating, and selecting data. The frontend communicates with the backend via APIs, allowing for a flexible and decoupled architecture.

The project utilizes Laravel Sanctum for authentication, which is a built-in feature that provides secure, stateless authentication for single-page applications.

The project also includes a static pricing page, which allows users to create a maximum of 10 short URLs. However, in future updates, we plan to expand the options available to users by offering packages that allow for the creation of additional URLs. This feature will enable users to tailor the service to their specific needs and use cases.

Future update: Users can buy packages to create more urls.

(back to top)

Built With

• Vue.js
• Laravel

(back to top)

Getting Started

sql file is included in repo to import directly in local database. Perform mentioned steps to have project running locally

Prerequisites

Requires minimum Versions

1. Vue - ^2.6
2. NPM - 6.13
3. Node - 12.14

Usage

STEP 1: Clone repo locally.

STEP 2: Navigate to backend folder serve backend. run following commands for migration

php artisan migrate
php artisan user:create "admin" "admin@gmail.com" "password" --force

STEP 3: Navigate to frontend folder and run following commands

npm install && npm run dev

For more information on how to install and use plugin, please refer to this (https://github.com/ZoreAnkit/url-shortener)

(back to top)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ankit Zore - ankitzore2@gmail.com

Project Link: https://github.com/ZoreAnkit/url-shortener

(back to top)