Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wuletawwonte/url-shortener
A mini-project that shortens long urls.
https://github.com/wuletawwonte/url-shortener
hotwire kaminari stimulusjs turboframe url
Last synced: 2 days ago
JSON representation
A mini-project that shortens long urls.
- Host: GitHub
- URL: https://github.com/wuletawwonte/url-shortener
- Owner: wuletawwonte
- License: mit
- Created: 2022-11-30T13:52:26.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-29T13:03:39.000Z (over 1 year ago)
- Last Synced: 2025-01-05T09:23:28.312Z (13 days ago)
- Topics: hotwire, kaminari, stimulusjs, turboframe, url
- Language: Ruby
- Homepage:
- Size: 71.3 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# URL-Shortener
> A mini-project that shortens long urls.
## Built With
- Ruby on Rails
- Ruby
- [Kaminari](https://github.com/kaminari/kaminari) pagination gem.
- [Stimulusjs](https://stimulus.hotwired.dev/)## Live Demo
[live link](#)
| Desktop | Mobile |
| ---------- | ----------- |
| | |## Getting Started
To get a local copy follow these simple example steps.
- Make sure you have Postgres and Ruby installed.
- Open the terminal window and clone the repository using this command: git clone https://github.com/wuletawwonte/url-shortener.git
- Open the repo by typing : cd url-shortener
- Install the project's dependencies by running this command: bundle install
- Run `rails db:create` to create the database.
- Run rails `rails db:schema:load` to create the relations in the database for the project based on the schema file inside the `db` folder.
- Run all unit tests in the project using `rspec`
- Run `rails server` or `./bin/dev` to start the application on local server.For developers run this command to auto build tailwindcss
```bash
./bin/dev
```## Authors
👤 **Wuletaw Wonte**
- GitHub: [@wuletawwonte](https://github.com/wuletawwonte)
- Twitter: [@wuletaww](https://twitter.com/wuletaww)
- LinkedIn: [LinkedIn](https://linkedin.com/in/wuletaw-wonte)## 🤝 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!
## Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration## 📝 License
This project is [MIT](./LICENSE.md) licensed.