UNPKG

eye.js

Version:

A JavaScript testing framework for the real world

144 lines (133 loc) 7.18 kB
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <link rel="alternate" hreflang="en-US" href=""> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="apple-touch-icon" href="apple-touch-icon.png"> <meta name="description" content="A JavaScript testing framework for the real world"> <meta name="keywords" content="JavaScript, framework, displayjs, display.js, arguiot, frontend, jquery, test, testing, jest, mocha"> <meta name="author" content="Arthur Guiot"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="twitter:card" content="summary_large_image"> <!-- twitter --> <meta name="twitter:site" content="@arthur_guiot"> <meta name="twitter:creator" content="@arthur_guiot"> <meta name="twitter:title" content="EyeJS"> <meta name="twitter:description" content="A JavaScript testing framework for the real world"> <meta name="twitter:image" content="https://eye.js.org/img/Banner.jpg"> <!-- Open graph met atags --> <meta property="og:title" content="EyeJS" /> <meta property="og:description" content="A JavaScript testing framework for the real world"/> <meta property="og:type" content="website" /> <meta property="og:url" content="https://eye.js.org" /> <meta property="og:image" content="https://eye.js.org/img/Banner.jpg" /> <title>EyeJS - testing framework</title> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/5.0.0/normalize.min.css"> <link rel='stylesheet prefetch' href='https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css'> <link rel="stylesheet" href="css/style.css"> <meta name="google-site-verification" content="GjXfnojrsoOmFbGpyYa_gmGEbP4651fAfHr-abDGFnE" /> </head> <body> <div class="menu"> <a href="javascript:;" id="toggle"> <i class="fa fa-bars" aria-hidden="true"></i> </a> <ul class="hover menu-ul"> <li><a href="https://github.com/arguiot/EyeJS">Github</a></li> <li><a href="https://github.com/arguiot/EyeJS/wiki">Docs</a></li> <li><a href="#install">Install</a></li> </ul> </div> <div class="logo"> <img src="https://cdn.rawgit.com/arguiot/EyeJS/master/docs/img/EyeJS-logo.svg" alt="Logo" class="logo-img"> <h1>EyeJS</h1> <h2>A JavaScript testing framework for the real world</h2> <div class="videoOverlay"> <i class="fa fa-play-circle toggleVideo" aria-hidden="true"></i> </div> </div> <div class="youtube videoOverlay"> <iframe width="560" height="315" src="https://www.youtube.com/embed/qWpT0tGuizI" frameborder="0" allowfullscreen></iframe> </div> <article> <section class="intro"> <h1>Introduction</h1> <p>Hello, I'm <a href="https://twitter.com/arthur_guiot">Arthur Guiot</a>, I created <a href="https://display.js.org">DisplayJS</a> not that long ago, and I figured out that I couldn't find an easy to setup testing framework. So, I wanted to create my own, and here it is. EyeJS is easy to setup, and has some unique features, such as the ability to test your project right in a browser, which make it adapted to real world test.</p> </section> <section id="install"> <h1>Installation</h1> <p>We recommend using <b>node 8</b>, but you still can run EyeJS on <b>node lts</b>.<br><br> You can quickly install a supported version of node with your favorite version manager: </p> <div class="code"> <script src="https://gist.github.com/arguiot/206d054925f472bd1fdb67c9acb01fc3.js"></script> </div> </section> <section> <h1>Concept</h1> <p>EyeJS have two test modes: the <b>node</b> mode, which run tests in a simple node environment, as Jest or Mocha would do. <br>And, our unique feature, which is the <b>browser</b> mode. It will tell your browser to do the tests.</p> </section> <section> <h1>Syntax</h1> <p>EyeJS have a pretty straight forward syntax, which make it easy to use. Here is a demo:</p> <div class="code"> <script src="https://gist.github.com/arguiot/84000d8834ddb15f9300bc99029856f6.js"></script> </div> </section> <section> <h1>Comparison</h1> <h3>Speed</h3> <p>Where other testing frameworks (such as Jest) are pretty slow, <b>EyeJS can do your tests under milliseconds</b></p> <h3>Features</h3> <p>EyeJS is made for the real world, so yes, other framework like Jest (yes, I'm comparing with Jest because it's the only one I know 😊), will have a richer API on the paper, <b>but can you run node based and broswer based tests using the same command with them?</b><br>EyeJS is focusing on the essential, if you need more complex functions, no one will stop 🛑 you from going on GitHub, forking the project and add more functions 😊.</p> <h3>Setup</h3> <p>EyeJS, and other testing frameworks are easy to "setup". But, we all know that setup means <b>setup + learn</b>, that's why <b>EyeJS is easy to learn and to use.</b></p> </section> <section> <h1>Conclusion</h1> <p>EyeJS is designed for teams or hobbyist with ambition, it has some unique features that makes it more than a simple framework, it's your second pair of <b>eyes!</b></p> </section> <section> <h1>Information</h1> <p> If you have any doubt, just create a new <a href="https://github.com/arguiot/EyeJS/issues">issue</a>. But normally, everything should be in the <a href="https://github.com/arguiot/EyeJS/wiki">docs</a>. <br>You can still: </p> <br> <a href="https://twitter.com/arthur_guiot" class="twitter">Tweet Me!</a> <p> <center> <a href="https://www.patreon.com/bePatron?u=10987869" data-patreon-widget-type="become-patron-button">Become a Patron!</a> </center> <script async src="https://c6.patreon.com/becomePatronButton.bundle.js"></script> </p> </section> <section class="space"></section> </article> <footer> <div class="love">Made with ❤️ by Arthur Guiot</div> <div class="links"> <ul> <li><a href="https://github.com/arguiot"><i class="fa fa-github" aria-hidden="true"></i></a></li> <li><a href="https://twitter.com/arthur_guiot"><i class="fa fa-twitter" aria-hidden="true"></i></a></li> <li><a href="https://codepen.io/arguiot"><i class="fa fa-codepen" aria-hidden="true"></i></a></li> </ul> </div> <div class="copyright">Copyright © 2017 - 2018 Arthur Guiot <br> All Rights Reserved.</div> </footer> <script src="https://cdnjs.cloudflare.com/ajax/libs/DisplayJS/2.1.0/display.min.js" integrity="sha256-oXA1LXU2RHFI9eY8Dxfsg+QzHkig6mjhGBB3DTG5kcU=" crossorigin="anonymous"></script> <script src='https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js'></script> <script src="js/index.js"></script> <!-- Global Site Tag (gtag.js) - Google Analytics --> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-107582164-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-107582164-1'); </script> <script src="https://www.w3counter.com/tracker.js?id=113653"></script> </body> </html>