Redway Newsletter Test Project

Description

This project is a test application for a job at Redway. It is a simple newsletter app designed to allow users to sign up for newsletters and receive a confirmation email with a blog link. Additionally, there is an admin feature that enables Redway administrators to download a list containing all the emails submitted by users.

Requirements

• Docker;
• Docker-compose;

Features

• Newsletter Signup: Users can enter their email and name to receive newsletters via email upon signup;
• Language selector: This app has English and Portuguese translations;
• Admin: Redway administrators can enter the admin page to see a list with all the leads imputed, and can download the list to a .TXT too.

Installation

1. Clone the repository:

   git clone https://github.com/JordanBiego/redway_newsletter

2. Navigate to the project directory:

   cd redway-newsletter

3. Build the Docker containers:

   docker-compose build

4. Run the migrations:

   docker-compose run web bin/rails db:migrate

5. Run the seed for the Admin login:

   docker-compose run web bin/rails db:seed

   5.1. To make the email system work, you need to rename the file env.example on the root of the project to .env and copy/paste the variables recieved via email:

   #./.env
   # paste the variables bello
   EMAIL=''
   PASSWORD=''
   SENDGRID_API_KEY=''

6. Run the app:

   docker-compose up

7. Visit http://localhost:3000 in your browser.

Usage

1. Access the application at http://localhost:3000.
2. Users can sign up for newsletters by entering their email and name.
3. Users receive a confirmation email with a blog link.
4. Redway administrators can download a list of all user-submitted emails.

License:

This project is purely educational, please do not redistribute without consent!