Skip to content

teekaytech/url-shortener

Repository files navigation

URL Shortener

An app built to shorten URLs, similar to what bit.ly does.

Built With

  • Ruby v.2.7.3
  • Ruby on Rails v.6.1.
  • SCSS
  • RSpec
  • Heroku
  • PostgreSQL v. >= 9.5

Live Demo

Right here

Getting Started

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

  • On the project GitHub page, navigate to the main page of the repository (i.e. this page.
  • Under the repository name, locate and click on a green button named Code.
  • Copy the project URL as displayed.
  • If you're running Windows Operating System, open your command prompt. On Linux, Open your terminal.
  • Change the current working directory to the location where you want the cloned directory to be made. Leave as it is if the current location is where you want the project to be.
  • Type git clone, and then paste the URL you copied in Step 3. $ git clone /~https://github.com/teekaytech/url-shortener
  • Press Enter. Your local copy will be created.

Prerequisites

The following must be installed on your PC.

  • Web Browser (Chrome/Firefox)
  • Node (Yarn)
  • Ruby v.2.7.3
  • Rails v.6.1.4
  • PostgreSQL
  • Fly.io (Deployment)

Demo

URL-Shortener

Setup

After cloning, the following steps setup the project

  • cd url-shortener to change the current working directory.
  • bundle install to install all necessary dependencies.
  • rails db:create && rails db:migrate to create database and tables.
  • rails s to start the application. You're all set!

Usage

Open your browser and go to http://localhost:3000 address.

Run tests

To run test suites included, run: bundle exec rspec

Deployment

To deploy this project to Heroku, kindly check this article for detailed instructions.

Author

👤 Taofeek Olalere

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

📝 License

This project is MIT licensed.

About

An app built to shorten URLs, similar to what bit.ly does.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published