yi-jian-mei

yi-jian-mei (一剪梅)

"xue hua piao piao bei feng xiao xiao"

NPM package that returns you the chorus lyrics of Fei Yu-ching's song, 一剪梅. This package is published on the NPM registry and is also available on GitHub.

Why?

Good question.

How to use

1. Install NodeJS and yarn (or use npm, it comes installed with NodeJS).

2. Go to an existing project or create a new project with:

   $ yarn init

3. Install the yi-jian-mei NPM package with:

   $ yarn add yi-jian-mei

4. Voila! You can now use the package in your code! For example:

   const yiJianMei = require('yi-jian-mei');
   
   const chorus = yiJianMei();
   // `chorus` should now be '雪花飘飘，北风萧萧'
   
   console.log(chorus);
   // You should now see '雪花飘飘，北风萧萧'

Setting up the development environment

1. Clone the repository

   $ git clone https://github.com/chrisgzf/yi-jian-mei

   or

   $ git clone [e-mail]:chrisgzf/yi-jian-mei

   if you use SSH with GitHub (you really should!)

2. Change directory to the source folder

   $ cd yi-jian-mei

3. Install dependencies

   yi-jian-mei $ yarn install

4. You can now edit the source code for this package!

5. To run tests, you can run:

   yi-jian-mei $ yarn test

6. Please note that as a community, we have decided to enforce strict testing, linting and styling. If you would like to contribute to the codebase, your PR has to pass all CI checks. You can run these checks locally with:

   yi-jian-mei $ yarn test && yarn lint-check && yarn prettier-check

Contributing

We accept PRs!