https://github.com/cyrus-kiprop/email_validator
A simple ruby on rails app for generating valid emails
https://github.com/cyrus-kiprop/email_validator
Last synced: 3 months ago
JSON representation
A simple ruby on rails app for generating valid emails
- Host: GitHub
- URL: https://github.com/cyrus-kiprop/email_validator
- Owner: Cyrus-Kiprop
- Created: 2020-10-23T13:20:43.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2020-10-27T15:07:38.000Z (over 4 years ago)
- Last Synced: 2025-01-11T17:15:36.519Z (4 months ago)
- Language: Ruby
- Size: 394 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
A Valid Email Generator
View Demo
·
Report Bug
·
Request Feature
## Table of Contents
- [About the Project](#about-the-project)
- [Live Demo](#live-demo)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#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 ](https://pacific-stream-82359.herokuapp.com/) for a live demo of the app.
### Built With
The project was built using the following languages stacks:
```sh
Back-End(server)
```
- [Ruby -v 2.7.2](https://ruby-doc.org/)
- [Ruby on Rails -v 5.2+](https://rubyonrails.org/)
```sh
Front-End(client)
```
- [ERB](https://guides.rubyonrails.org/layouts_and_rendering.html)
- [Sass](https://sass-lang.com/)
- [Font Awesome Icons](https://fontawesome.com/icons?d=gallery)
```sh
Testing Frameworks
```
- shoulda_matchers
- [RSpec](https://rspec.info/)
- 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](https://www.ruby-lang.org/en/)
- Rails -v 5.2.4
```sh
gem install rails -v 5.2.4
```
- Postgresql database [click here](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-18-04)
### Installation
1. Clone the repo
```sh
git clone https://github.com/Cyrus-Kiprop/email_validator.git
```
2. CD into the project root directory
```sh
cd ./email_validator
```
3. Install Dependencies and gems
```sh
bundle install
```
4. Set the databases
```sh
rails db:create
```
5. Create database schemas
```sh
rails db:migrate
```
### SETUP API_KEY
Create an env.yml file in ./config directory of the app
```JS
touch env.yml
```
Add the following content to the file
```JS
API_KEY: 'your api access key'
```
:red_heart: :blue_heart: :green_heart:
## Usage
### Fire up the server:
```JS
rails s
```
### Navigate to your browser and open port 3000:
```JS
http//localhost:3000
```
## Roadmap
See the [open issues](https://github.com/Cyrus-Kiprop/email_validator/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 - [email protected]
Project Link: [https://github.com/Cyrus-Kiprop/email_validator](https://github.com/Cyrus-Kiprop/email_validator)
## Authors
👤 **Cyrus Kiprop**
- Github: [Cyrus-Kiprop](https://github.com/Cyrus-Kiprop)
- Twitter: [@kipropJS](https://twitter.com/kipropJS)
- Linkedin: [Cyrus Kiprop](https://www.linkedin.com/in/cyrus-kiprop-ba7320120/)
## Acknowledgements
- [Heroku](https://pacific-stream-82359.herokuapp.com/)
- [Font Awesome](https://fontawesome.com)
- [Best-README-Template](https://github.com/othneildrew/Best-README-Template)
## License
Distributed under the MIT License. See [ LICENSE ](https://github.com/Cyrus-Kiprop/email_validator/blob/master/LICENSE) for more information.
[contributors-shield]: https://img.shields.io/github/contributors/Cyrus-Kiprop/email_validator.svg?style=flat-square
[contributors-url]: https://github.com/Cyrus-Kiprop/email_validator/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Cyrus-Kiprop/email_validator.svg?style=flat-square
[forks-url]: https://github.com/Cyrus-Kiprop/email_validator/network/members
[stars-shield]: https://img.shields.io/github/stars/Cyrus-Kiprop/email_validator.svg?style=flat-square
[stars-url]: https://github.com/Cyrus-Kiprop/email_validator/stargazers
[issues-shield]: https://img.shields.io/github/issues/Cyrus-Kiprop/email_validator.svg?style=flat-square
[issues-url]: https://github.com/Cyrus-Kiprop/email_validator/issues
[product-screenshot]: ./aapp.png