📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 URL SHORTENER

URL SHORTENER is an application that that allows you to enter a long URL and receive a shortened version in return. It is convenient it looks streamlined in appearance. You can also create your custom endpoint.

🛠 Built With

Tech Stack

Mainly Ruby on Rails with StimulusJS.

Framework

• StimuusJS

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• It shortens long urls and returns a short one
• Users can create their custom endpoint (shortened url)

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node
• Ruby
• PostgreSQL
• Rails
• Rbenv

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Gambit142/Url_Shortener.git
  cd Url_Shortener

Install

Install this project with:

bundle install

Database creation

Next, use this command to create the databases:

rails db:create

Run Migrations

Next, use this command to run the migration files:

rails db:migrate

Usage

To run the project, execute the following command:

  rails server

(back to top)

👥 Authors

👤 Author

• GitHub: @Gambit142
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Have a way to get the metrics of most clicked links and other metrics
• Use CanCanCan for Authorization so that users can only see shortened urls they created
• Set duration for how long a link is valid

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)