https://github.com/teekaytech/url-shortener
An app built to shorten URLs, similar to what bit.ly does.
https://github.com/teekaytech/url-shortener
shortener url
Last synced: 8 months ago
JSON representation
An app built to shorten URLs, similar to what bit.ly does.
- Host: GitHub
- URL: https://github.com/teekaytech/url-shortener
- Owner: teekaytech
- Created: 2022-03-02T15:36:58.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-01T12:30:41.000Z (over 3 years ago)
- Last Synced: 2025-07-30T01:57:50.947Z (10 months ago)
- Topics: shortener, url
- Language: Ruby
- Homepage: https://calm-falls-19529.herokuapp.com/
- Size: 176 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# URL Shortener
> An app built to shorten URLs, similar to what [bit.ly](https://bitly.com/) 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](https://calm-falls-19529.herokuapp.com/)
## 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](https://github.com/teekaytech/url-shortener).
- 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](https://spring-pond-4903.fly.dev/)
### 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](https://devcenter.heroku.com/articles/getting-started-with-rails6) for detailed instructions.
## Author
👤 **Taofeek Olalere**
- Github: [@teekaytech](https://github.com/teekaytech)
- Twitter: [@ola_lere](https://twitter.com/ola_lere)
- Linkedin: [olaleretaofeek](https://linkedin.com/in/olaleretaofeek)
- Portfolio: [Olalere Taofeek](https://teekaytech.github.io/olaleretaofeek/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](./MIT.md) licensed.