Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/genesisgonza05/lemontech_events
Lemontech Events es una aplicación de gestión de eventos construida con Ruby on Rails y Docker, utilizando PostgreSQL como base de datos.
https://github.com/genesisgonza05/lemontech_events
css cucumber docker docker-compose html javascript letter-opener recaptcha rspec ruby ruby-on-rails
Last synced: 13 days ago
JSON representation
Lemontech Events es una aplicación de gestión de eventos construida con Ruby on Rails y Docker, utilizando PostgreSQL como base de datos.
- Host: GitHub
- URL: https://github.com/genesisgonza05/lemontech_events
- Owner: genesisgonza05
- Created: 2024-06-20T01:29:20.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-06-28T21:14:28.000Z (6 months ago)
- Last Synced: 2024-11-09T17:40:56.336Z (about 2 months ago)
- Topics: css, cucumber, docker, docker-compose, html, javascript, letter-opener, recaptcha, rspec, ruby, ruby-on-rails
- Language: HTML
- Homepage:
- Size: 1.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# README
# Lemontech Events
[![Maintainability](https://api.codeclimate.com/v1/badges/7453c6a8f222864d2d23/maintainability)](https://codeclimate.com/github/genesisgonza05/lemontech_events/maintainability)
[![Coverage Status](badge.svg)](https://github.com/genesisgonza05/lemontech_events)
![Docker](https://img.shields.io/badge/docker-ready-blue.svg)
![Ruby on Rails](https://img.shields.io/badge/Rails-7.1.3.3-orange.svg)
![Ruby](https://img.shields.io/badge/Ruby-3.3.1-red)Lemontech Events es una aplicación de gestión de eventos construida con Ruby on Rails y Docker, utilizando PostgreSQL como base de datos. Esta aplicación permite a los usuarios registrarse y autenticarse para gestionar sus eventos.
## Requisitos Previos
> IMPORTANTE!: Asegúrate de tener instalados los siguientes programas en tu máquina para iniciar la configuración del proyecto:
- [Docker](https://www.docker.com/products/docker-desktop)
- [Docker Compose](https://docs.docker.com/compose/install/)## Para levantar la aplicación por primera vez
Sigue estos pasos para configurar y levantar la aplicación por primera vez:
### 1. Clonar el Repositorio
> Clonado y acceso al proyecto
Clona el proyecto en tu local desde el terminal y accede en el folder del proyecto
```sh
git clone https://github.com/genesisgonza05/lemontech_events.git
cd lemontech_events
```### 2. Incorporar las variables de entorno
> Copiado de las variables de entorno
Para esto, primero crea el archivo .env en la raiz del proyecto:
```sh
touch .env
```Luego copia y pega este listado de variables de entorno en el archivo .env en la raiz del proyecto y guarda los cambios en el archivo.
> _El valor de estas variables se encuentran en el archivo de documentacion del proyecto "Documentación de LemontechEvents", solicitar este documento a un code owner._
```sh
RECAPTCHA_SITE_KEY=_request_var_to_any_code_owner_
RECAPTCHA_SECRET_KEY=_request_var_to_any_code_owner_
```### 3. Construir Contenedores de Docker
> Construcción y levantado de contenedores
Construye y levanta los contenedores de Docker por medio del siguiente comando:
```sh
docker-compose up -d
```### 4. Disponibilizar la Base de Datos
> Creación de la base de datos y set de datos iniciales
Crea la base de datos, realiza la migración y ejecuta el seed para inicializarla con datos con los siguientes 3 comandos respectivamente:
```sh
docker-compose run web rake db:create
docker-compose run web rake db:migrate
docker-compose run web rake db:seed
```### 5. Levantar la aplicación
> Despliegue de la aplicación
Una vez realizados los 4 pasos anteriores, puedes levantar la aplicación con el siguiente comando:
```sh
docker-compose up
```Ya puedes ver el proyecto en tu local accediendo a la url que se genero desde la consola: http://localhost:3000/
> La aplicación cuenta con un usuario precargado con datos base para pruebas: (Email: [email protected] | Password: 123456)
## Levantar la aplicación frecuentemente
Una vez que has hecho la configuración inicial, puedes levantar la aplicación frecuentemente con:
```sh
docker-compose up
```Para detener los contenedores:
```sh
docker-compose down
```## Ejecutar Pruebas
Para ejecutar las pruebas de Rspec (Unitarias):
```sh
docker-compose run test rspec
```Para ejecutar las pruebas de Cucumber (de Integración):
```sh
docker-compose run test cucumber
```## Mailing
El proyecto cuenta con revision de emails con letter_opener_web en el ambiente de desarrollo, si deseas ver los emails enviados en tu entorno de desarrollo tan solo entra al siguiente enlace:
[http://localhost:3000/letter_opener](http://localhost:3000/letter_opener)![Gestor de emails de la aplicación](public/emails-manager.png)