Cyrus-Kiprop/email_validator

A simple ruby on rails app for generating valid emails

A Valid Email Generator

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Live Demo
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

A ruby on Rails application that lets users find valid email addresses based on the contact’s name and url.

Live Demo

Click here for a live demo of the app.

Built With

The project was built using the following languages stacks:

Back-End(server)

• Ruby -v 2.7.2
• Ruby on Rails -v 5.2+

Front-End(client)

• ERB
• Sass
• Font Awesome Icons

Testing Frameworks

• shoulda_matchers
• RSpec
• Factories gem

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Ruby -v 2.7.2 -click here

• Rails -v 5.2.4

gem install rails -v 5.2.4

• Postgresql database click here

Installation

1. Clone the repo

git clone https://github.com/Cyrus-Kiprop/email_validator.git

2. CD into the project root directory

cd ./email_validator

3. Install Dependencies and gems

bundle install

4. Set the databases

rails db:create

5. Create database schemas

rails db:migrate

SETUP API_KEY

Create an env.yml file in ./config directory of the app

touch env.yml

Add the following content to the file

API_KEY: 'your api access key'

:red_heart: 💙 💚

Usage

Fire up the server:

rails s

Navigate to your browser and open port 3000:

http//localhost:3000

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/NewAwesomeFeature)
3. Commit your Changes (git commit -m 'Add some NewAmazingFeature')
4. Push to the Branch (git push origin feature/NewAmazingFeature)
5. Open a Pull Request

Contact

Cyrus Kiprop - cyruskiprop254@gmail.com

Project Link: https://github.com/Cyrus-Kiprop/email_validator

Authors

👤 Cyrus Kiprop

• Github: Cyrus-Kiprop
• Twitter: @kipropJS
• Linkedin: Cyrus Kiprop

Acknowledgements

• Heroku
• Font Awesome
• Best-README-Template

License

Distributed under the MIT License. See LICENSE for more information.