alexanderc / recink

REciNK - Rethink Continuous Integration for JavaScript Applications

REciNK - Rethink Continuous Integration for JavaScript Applications

REciNK was born from our need to automate the execution of JavaScript tests. We quickly realized that we need to RETHINK (aka REciNK) entire Continuous Integration process for JavaScript applications. Similar to .travis.yml, we empower developers to simply drop the .recink.yml config file into GitHub repository and follow below Getting Started guide to use it as part of their Continuous Integration pipeline (maybe even extend to Continuous Deployment).

Features

• Install. Configure. Use.
• Multi-module support for consolidated coverage.
• Built-in support for Travis, NPM, Chai, Mocha, Istanbul, TestCafe.
• Amazon S3 powered caching.
• Extendable. Debuggable. Documented.

Prerequisites

• Git >= v1.x
• Node.js >= v6.x
• NPM >= v3.x

Use nvm to install and manage different versions of Node.js; Ideally, use v8+ for faster performance

Installation

npm install -g recink

Getting Started

@See User Guide

Usage

recink run [name] [path]               # Run a generic component
recink run unit [path]                 # Run unit tests                              
recink run e2e [path]                  # Run end to end tests                        
recink configure recink [path]         # Configure REciNK                            
recink configure travis [path]         # Configure Travis                            
recink travis encrypt [path]           # Encrypt Travis environment variables        
recink travis lint [path]              # Lint Travis configuration                   
recink component generate [path]       # Generate REciNK boilerplate component       
recink component add [name...]         # Add an REciNK component to the registry     
recink component remove [name...]      # Remove an REciNK component from the registry
recink component list                  # List REciNK components from the registry    
recink help <command>                  # Display help for a specific command   

Debugging

To enable debug mode for both unit and e2e runtimes use DEBUG=* recink run unit|e2e.

TestCafe offers amazing debugging capabilities documented here.

We are using Puppeteer as default browser, which provides native debugging capabilities documented here.

Use -v flag to enable verbose mode on any recink command.

Supported CI Platforms

• Travis
• Travis Pro

Documentation

• Quick Start Guide
• Crafting Components
• API Docs
• Module Diagram
• FAQ

Components

• 🏠 CodeClimate
• 🏠 Snyk.io
• 🏠 PageSpeed
• 🏠 Comment
• 🏠 Terraform

Explore in-house built components here

Projects Using "REciNK"

• Deep Framework

To add you project to this list please open a PR ;)

Roadmap

• Implement smart cache invalidation
• Add support for external components
• Add support for fully automated Travis configuration
• Add support for End-to-End tests
• Add component development guide
• Add unit tests for critical functionality
• Add support for different CI platforms
• Craft a cool logo for the project 👽
• Add unit tests to cover at least 80% of codebase

Sponsors

This repository is being sponsored by:

• Mitoc Group
• AdTechMedia

License

recink is released under the MIT license.

Copyright (c) 2017 Mitoc Group Inc

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.