https://github.com/franciscojbrito/shortener
Link Shortener app with RoR, web application designed to shorten long URLs, making them easier to share and manage.
https://github.com/franciscojbrito/shortener
docker javascript ruby ruby-on-rails
Last synced: 3 months ago
JSON representation
Link Shortener app with RoR, web application designed to shorten long URLs, making them easier to share and manage.
- Host: GitHub
- URL: https://github.com/franciscojbrito/shortener
- Owner: FranciscoJBrito
- License: mit
- Created: 2024-05-20T00:21:59.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-01T06:05:17.000Z (about 2 years ago)
- Last Synced: 2025-01-11T22:45:59.829Z (over 1 year ago)
- Topics: docker, javascript, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 123 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shortener
## Description
**Shortener** is a web application designed to shorten long URLs, making them easier to share and manage. This project uses Ruby on Rails for the backend and Tailwind CSS along with Stimulus for the frontend, providing a fast and reliable URL shortening service.
## Features
- Shorten long URLs to short, easy-to-remember links.
- Fast and efficient redirection.
- Simple and intuitive user interface.
- Storage of shortened links.
- Basic usage statistics (coming soon).
## Technologies Used
- Ruby, Ruby on Rails
- Tailwind CSS, Stimulus
- PostgreSQL
- Docker
## Installation
### Prerequisites
- Ruby 3.0.6
- Rails 7.0.8
- PostgreSQL
- Docker (optional)
### Clone the Repository
```bash
git clone https://github.com/FranciscoJBrito/shortener.git
cd shortener
```
### Environment Setup
Create a .env file in the root of the project with the following environment variables:
```env
RAILS_ENV=development
DATABASE_USERNAME=postgres
DATABASE_PASSWORD=123456
DATABASE_HOST=postgres
DATABASE_PORT=5432
HOST=localhost:3000
```
### Run with Docker
Build and run Docker containers:
```bash
docker-compose up --build
```
The application will be available at `http://localhost:3000`.
### Contributing
Contributions are welcome. To contribute, follow these steps:
1. Fork the repository.
2. Create a new branch (git checkout -b feature/new-feature).
3. Make your changes and commit them (git commit -am 'Add new feature').
4. Push your changes to your fork (git push origin feature/new-feature).
5. Open a Pull Request.