asciidisco/cfp-magick

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# cfp-magick

[![Build Status](https://travis-ci.org/asciidisco/cfp-magick.svg?branch=master)](https://travis-ci.org/asciidisco/cfp-magick)
[![npm](https://img.shields.io/npm/v/cfp-magick.svg)](https://www.npmjs.com/package/cfp-magick)
[![dependencies Status](https://david-dm.org/asciidisco/cfp-magick/status.svg)](https://david-dm.org/asciidisco/cfp-magick)
[![dependencies Status](https://david-dm.org/asciidisco/cfp-magick/dev-status.svg)](https://david-dm.org/asciidisco/cfp-magick#info=devDependencies)
[![Test Coverage](https://api.codeclimate.com/v1/badges/cef0e6703b53514c4863/test_coverage)](https://codeclimate.com/github/asciidisco/cfp-magick/test_coverage)
[![Maintainability](https://api.codeclimate.com/v1/badges/cef0e6703b53514c4863/maintainability)](https://codeclimate.com/github/asciidisco/cfp-magick/maintainability)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fasciidisco%2Fcfp-magick.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fasciidisco%2Fcfp-magick?ref=badge_shield)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Greenkeeper badge](https://badges.greenkeeper.io/greenkeeperio/greenkeeper.svg)](https://greenkeeper.io/)
[![Known Vulnerabilities](https://snyk.io/test/github/asciidisco/cfp-magick/badge.svg)](https://snyk.io/test/github/asciidisco/cfp-magick)

CLI applications that shows JavaScript and Web conferences with open calls for papers

![Demo](https://raw.githubusercontent.com/asciidisco/cfp-magick/master/demo.gif)

### Installing

Install the application via `npm` or use it on demand via `npx`:

```bash
npm install cfp-magick -g
```

```bash
npx cfp-magick
```

## Development

Fork and clone this repo and install all the needed dependencies
by issuing ```npm install``` in the root directory.

## Running the tests

Tests are located on the `__tests__` folder and can be run by calling ```npm test``` from the root dir of the project.

### And coding style tests

We adhere to the [Standard](https://github.com/standard/standard) coding guidelines.
You can lint you code using ```npm run lint```

## Built With

* [Chalk](https://github.com/chalk/chalk) - For beautiful colors
* [NPM](https://www.npmjs.com/) - Dependency Management
* [Commitizen](https://github.com/commitizen/cz-cli) - Easy semantic commit messages
* [Jest](https://facebook.github.io/jest/) - Easy tests
* [Semantic Release](https://github.com/semantic-release/semantic-release) - Easy software releases

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our [code of conduct](code-of-conduct.md), and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/asciidisco/cfp-magick/tags).

## Authors

* **Sebastian Golasch** - *Initial work* - [asciidisco](https://github.com/asciidisco)

See also the list of [contributors](https://github.com/ascidiisco/cfp-magick/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fasciidisco%2Fcfp-magick.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fasciidisco%2Fcfp-magick?ref=badge_large)