https://github.com/truggeri/rails-url-shortener

A Ruby on Rails based url shortener
https://github.com/truggeri/rails-url-shortener

docker heroku openapi postgres rails rspec rubocop

Last synced: 7 days ago
JSON representation

A Ruby on Rails based url shortener

• Host: GitHub
• URL: https://github.com/truggeri/rails-url-shortener
• Owner: truggeri
• License: mit
• Created: 2021-06-21T20:16:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-16T03:40:15.000Z (about 2 years ago)
• Last Synced: 2024-11-11T08:27:34.849Z (2 months ago)
• Topics: docker, heroku, openapi, postgres, rails, rspec, rubocop
• Language: Ruby
• Homepage: https://short.truggeri.com
• Size: 123 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rails Url Shortener

[![Test](https://github.com/truggeri/rails-url-shortener/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/truggeri/rails-url-shortener/actions/workflows/test.yml)

![Coverage Badge](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)

A simple Rails application that implements an api based url shortener.

![RoR Badge](https://img.shields.io/badge/-Ruby_On_Rails-b32424?style=flat&labelColor=cc0000&logo=ruby-on-rails&logoColor=white)

![PostgreSQL Badge](https://img.shields.io/badge/-PostgreSQL-426078?style=flat&labelColor=336791&logo=postgresql&logoColor=white)

[![Github Badge](https://img.shields.io/badge/-GitHub-322626?style=flat&labelColor=181717&logo=github&logoColor=white)](https://github.com/truggeri/rails-url-shortener)

[![GitHub Actions Badge](https://img.shields.io/badge/-GitHub_Actions-4b93e6?style=flat&labelColor=2088FF&logo=github-actions&logoColor=white)](https://github.com/truggeri/rails-url-shortener/actions)

[![OpenAPI Badge](https://img.shields.io/badge/-OpenAPI_Spec-8dd152?style=flat&labelColor=85EA2D&logo=swagger&logoColor=white)](./docs/api-spec.yaml)

[![Docker Badge](https://img.shields.io/badge/-Docker-4b99d4?style=flat&labelColor=2496ED&logo=docker&logoColor=white)](./Dockerfile)

## Requirements and Design

For detailed information on the requirements and design, see [our detailed design documentation](docs/design.md).

## Development

To get started, you'll need to setup dependencies.

### PostgreSQL Database

This app uses [PostgreSQL 13](https://www.postgresql.org/docs/13/) for it's datastore. In order to configure one, provide a database URL via an environment variable.

```bash

export DATABASE_URL=postgres://:@:/rails_url_shortener

```

This database can be setup in any fashion that you choose. Options include [local install](https://www.postgresql.org/download/), [Docker](https://hub.docker.com/_/postgres?tab=description), or as [a web service](https://www.heroku.com/postgres). If you'd like to use Docker, we have a [Docker Compose](https://docs.docker.com/compose/) [file](./docker-compose.yml) to help,

```bash

cat docker-compose.env

 export URL_SHORTENER_DB_DATABASE=rails_url_shortener

 export URL_SHORTENER_DB_PASSWORD=somepassword

 export URL_SHORTENER_DB_USERNAME=database_user

 export URL_SHORTENER_DB_URL=postgres://$URL_SHORTENER_DB_USERNAME:$URL_SHORTENER_DB_PASSWORD@localhost:5432/$URL_SHORTENER_DB_DATABASE

source docker-compose.env

docker-compose up --detach db

```

### Docker

If you'd like to run the application using Docker, there is a [Dockerfile](./Dockerfile) provided.

To use, build the container first and then run it with your configured database and port settings.

```bash

docker build -t rails-url-shortener .

docker run --rm -e DATABASE_URL=$DATABASE_URL -p 3000:3000 rails-url-shortener

```

## Future Improvements

Of course, there's always more to do. [Read our documentation](./docs/future_improvements.md) on

ideas for improvements and future work.