mdo-npm-library-boilerplate
v0.0.3
Published
A simple npm library boilerplate, to serve as a starting point for all MDO npm based libraries.
Readme
��#� �m�d�o�-�n�p�m�-�l�i�b�r�a�r�y�-�b�o�i�l�e�r�p�l�a�t�e� �&�m�i�d�d�o�t�;� �[�!�[�C�i�r�c�l�e�C�I� �S�t�a�t�u�s�]�(�h�t�t�p�s�:�/�/�c�i�r�c�l�e�c�i�.�c�o�m�/�g�h�/�e�s�c�o�b�a�r�d�/�c�l�o�u�d�-�a�p�p�s�.�s�v�g�?�s�t�y�l�e�=�s�h�i�e�l�d�&�c�i�r�c�l�e�-�t�o�k�e�n�=�:�c�i�r�c�l�e�-�t�o�k�e�n�)�]�(�h�t�t�p�s�:�/�/�a�p�p�.�c�i�r�c�l�e�c�i�.�c�o�m�/�p�i�p�e�l�i�n�e�s�/�g�i�t�h�u�b�/�e�s�c�o�b�a�r�d�/�c�l�o�u�d�-�a�p�p�s�)� �[�!�[�P�R�s� �W�e�l�c�o�m�e�]�(�h�t�t�p�s�:�/�/�i�m�g�.�s�h�i�e�l�d�s�.�i�o�/�b�a�d�g�e�/�P�R�s�-�w�e�l�c�o�m�e�-�b�r�i�g�h�t�g�r�e�e�n�.�s�v�g�)�]�(�h�t�t�p�s�:�/�/�g�i�t�h�u�b�.�c�o�m�/�e�s�c�o�b�a�r�d�/�c�l�o�u�d�-�a�p�p�s�#�p�u�l�l�-�r�e�q�u�e�s�t�s�)�
�
�
�
�A� �s�i�m�p�l�e� �n�p�m� �l�i�b�r�a�r�y� �b�o�i�l�e�r�p�l�a�t�e�,� �t�o� �s�e�r�v�e� �a�s� �a� �s�t�a�r�t�i�n�g� �p�o�i�n�t� �f�o�r� �a�l�l� �M�D�O� �n�p�m� �b�a�s�e�d� �l�i�b�r�a�r�i�e�s�.�
�
�
�
�#�#� �Q�u�i�c�k�s�t�a�r�t�
�
�
�
�[�N�o�d�e�.�j�s�]�(�h�t�t�p�s�:�/�/�n�o�d�e�j�s�.�o�r�g�/�e�n�/�)� �a�n�d� �[�n�p�m�]�(�h�t�t�p�s�:�/�/�w�w�w�.�n�p�m�j�s�.�c�o�m�/�)� �m�u�s�t� �b�e� �i�n�s�t�a�l�l�e�d�.�
�
�
�
�#�#�#�#� �S�t�a�r�t� �a�p�p�l�i�c�a�t�i�o�n�
�
��n�p�m� �r�u�n� �s�t�a�r�t��
�
�
�
�#�#�#�#� �U�n�i�t� �t�e�s�t�s�
�
�
�
��n�p�m� �r�u�n� �t�e�s�t��
�
�
�
�#�#� �L�i�b�r�a�r�y� �o�n� �n�p�m�
�
�
�
�h�t�t�p�s�:�/�/�w�w�w�.�n�p�m�j�s�.�c�o�m�/�p�a�c�k�a�g�e�/�m�d�o�-�n�p�m�-�l�i�b�r�a�r�y�-�b�o�i�l�e�r�p�l�a�t�e�
�
�
�
�#�#� �C�o�m�m�i�t�s�
�
�
�
�O�u�r� �c�o�m�m�i�t�s� �f�o�l�l�o�w� �t�h�e� �[�A�n�g�u�l�a�r� �c�o�m�m�i�t� �s�t�y�l�e�g�u�i�d�e�]�(�h�t�t�p�s�:�/�/�g�i�s�t�.�g�i�t�h�u�b�.�c�o�m�/�b�r�i�a�n�c�l�e�m�e�n�t�s�/�8�4�1�e�a�7�b�f�f�d�b�0�1�3�4�6�3�9�2�c�)�.� �E�a�c�h� �c�o�m�m�i�t� �s�h�o�u�l�d� �b�e� �c�a�r�e�f�u�l�l�y� �t�h�o�u�g�h�t� �o�u�t� �a�n�d� �o�n�l�y� �c�o�n�t�a�i�n� �f�i�l�e�s� �a�f�f�e�c�t�e�d� �w�i�t�h�i�n� �t�h�e� �s�c�o�p�e� �o�f� �t�h�e� �c�o�m�m�i�t� �m�e�s�s�a�g�e�.�
�
�
�
�#�#� �B�r�a�n�c�h�i�n�g�
�
�
�
�A� �b�r�a�n�c�h�'�s� �n�a�m�e� �s�h�o�u�l�d� �r�e�f�e�r�e�n�c�e� �a� �J�I�R�A� �c�a�r�d�.�
�
�
�
�#�#� �P�u�l�l� �R�e�q�u�e�s�t�s�
�
�
�
�E�a�c�h� �p�u�l�l� �r�e�q�u�e�s�t� �m�u�s�t� �p�a�s�s� �a� �r�e�v�i�e�w� �f�r�o�m� �a�n�o�t�h�e�r� �c�o�n�t�r�i�b�u�t�o�r� �a�n�d� �a�l�l� �a�u�t�o�m�a�t�e�d� �t�e�s�t�s�.�
�
�
�
�#�#� �L�i�b�r�a�r�i�e�s�,� �F�r�a�m�e�w�o�r�k�s� �&� �T�o�o�l�s�
�
�
�
�[�N�o�d�e�.�j�s�]�(�h�t�t�p�s�:�/�/�n�o�d�e�j�s�.�o�r�g�/�e�n�/�)�
�
�
�
�[�n�p�m�]�(�h�t�t�p�s�:�/�/�w�w�w�.�n�p�m�j�s�.�c�o�m�/�)�
�
�
�
�#�#� �L�i�c�e�n�s�e�
�
�
�
�T�h�i�s� �r�e�p�o�s�i�t�o�r�y� �i�s� �p�r�o�t�e�c�t�e�d� �u�n�d�e�r� �t�h�e� �[�M�D�O� �L�i�c�e�n�s�e�]�(�h�t�t�p�s�:�/�/�g�i�t�h�u�b�.�c�o�m�/�M�y�D�i�g�i�t�a�l�O�f�f�i�c�e�-�G�l�o�b�a�l�/�m�d�o�-�n�p�m�-�l�i�b�r�a�r�y�-�b�o�i�l�e�r�p�l�a�t�e�/�L�I�C�E�N�S�E�.�m�d�)�.�
�
�
