https://github.com/jpcano/sendero-quotes

Skeleton of a complete js project
https://github.com/jpcano/sendero-quotes

Last synced: 3 months ago
JSON representation

Skeleton of a complete js project

• Host: GitHub
• URL: https://github.com/jpcano/sendero-quotes
• Owner: jpcano
• Created: 2017-07-11T15:43:52.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-07-20T08:25:07.000Z (almost 8 years ago)
• Last Synced: 2025-02-12T21:01:42.183Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 12.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# sendero-quotes

[![Travis](https://img.shields.io/travis/jpcano/sendero-quotes.svg)](https://travis-ci.org/jpcano/sendero-quotes)

[![Codecov](https://img.shields.io/codecov/c/github/jpcano/sendero-quotes.svg)](https://codecov.io/gh/jpcano/sendero-quotes)

[![version](https://img.shields.io/npm/v/sendero-quotes.svg)](http://npm.im/sendero-quotes)

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

Skeleton of a complete js project.

This is a toy project that can be used as a starting point for other projects. It has the following features already configured:

- Transipilation of ES6 code with **babel**

- Tests with **mocha** and **chai**

- Coverage with **nyc**

- Coverage reports to **codecov.io**

- Continuous integration with **Travis**

- Preformated commits with **commitizen** and the CLI **cz-conventional-changelog**

- Pre commit git hooks with **husky**

- Automated npm package release and versioning with **semantic-release**

- Browser build with **webpack**

- Different **badges** in the Readme file.

It was inspired by this excellent [course](https://egghead.io/courses/how-to-write-an-open-source-javascript-library) by egghead.io.

The module exposes the function *random(n)* which returns n random quotes from the book "El sendero de la mano izquierda" by the spanish writer Fernando Sánchez Dragó.