nest-bootstrap-cli
v1.0.1
Published
A simple CLI tool to bootstrap NestJS project with TypeORM and Swagger
Downloads
9
Readme
��#� �n�e�s�t�-�b�o�o�t�s�t�r�a�p�-�c�l�i�
�
�
�
�A� �s�i�m�p�l�e� �C�L�I� �t�o�o�l� �t�o� �b�o�o�t�s�t�r�a�p� �a� �N�e�s�t�J�S� �p�r�o�j�e�c�t� �w�i�t�h� �T�y�p�e�O�R�M� �a�n�d� �S�w�a�g�g�e�r�.�
�
�
�
�#�#� �F�e�a�t�u�r�e�s�
�
�
�
�-� ���N�e�s�t�J�S���:� �A� �p�r�o�g�r�e�s�s�i�v�e� �N�o�d�e�.�j�s� �f�r�a�m�e�w�o�r�k� �f�o�r� �b�u�i�l�d�i�n�g� �e�f�f�i�c�i�e�n�t�,� �r�e�l�i�a�b�l�e�,� �a�n�d� �s�c�a�l�a�b�l�e� �s�e�r�v�e�r�-�s�i�d�e� �a�p�p�l�i�c�a�t�i�o�n�s�.�
�
�-� ���T�y�p�e�O�R�M���:� �A�n� �O�R�M� �t�h�a�t� �c�a�n� �r�u�n� �i�n� �N�o�d�e�J�S�,� �B�r�o�w�s�e�r�,� �C�o�r�d�o�v�a�,� �P�h�o�n�e�G�a�p�,� �I�o�n�i�c�,� �R�e�a�c�t� �N�a�t�i�v�e�,� �N�a�t�i�v�e�S�c�r�i�p�t�,� �E�x�p�o�,� �a�n�d� �E�l�e�c�t�r�o�n� �p�l�a�t�f�o�r�m�s�.�
�
�-� ���S�w�a�g�g�e�r���:� �A� �t�o�o�l� �t�o� �g�e�n�e�r�a�t�e� �A�P�I� �d�o�c�u�m�e�n�t�a�t�i�o�n� �a�n�d� �p�r�o�v�i�d�e� �a� �u�s�e�r� �i�n�t�e�r�f�a�c�e� �t�o� �i�n�t�e�r�a�c�t� �w�i�t�h� �t�h�e� �A�P�I�.�
�
�
�
�#�#� �I�n�s�t�a�l�l�a�t�i�o�n�
�
�
�
�T�o� �i�n�s�t�a�l�l� �t�h�e� �C�L�I� �t�o�o�l�,� �r�u�n�:�
�
�
�
��
��b�a�s�h�
�
�n�p�m� �i�n�s�t�a�l�l� �-�g� �n�e�s�t�-�b�o�o�t�s�t�r�a�p�-�c�l�i�
�
�
��
�
�
�
�
�#�#� �U�s�a�g�e�
�
�
�
�T�o� �c�r�e�a�t�e� �a� �n�e�w� �N�e�s�t�J�S� �p�r�o�j�e�c�t� �w�i�t�h� �T�y�p�e�O�R�M� �a�n�d� �S�w�a�g�g�e�r�,� �r�u�n�:�
�
�
�
��
��b�a�s�h�
�
�n�e�s�t�-�b�o�o�t�s�t�r�a�p�-�c�l�i� �n�e�w� �<�p�r�o�j�e�c�t�-�n�a�m�e�>�
�
�
��
�
�
�
�
�R�e�p�l�a�c�e� ��<�p�r�o�j�e�c�t�-�n�a�m�e�>�
� �w�i�t�h� �t�h�e� �d�e�s�i�r�e�d� �n�a�m�e� �o�f� �y�o�u�r� �p�r�o�j�e�c�t�.�
�
�
�
�#�#� �C�o�m�m�a�n�d�s�
�
�
�
�-� ��n�e�w� �<�p�r�o�j�e�c�t�-�n�a�m�e�>�
�:� �C�r�e�a�t�e�s� �a� �n�e�w� �N�e�s�t�J�S� �p�r�o�j�e�c�t� �w�i�t�h� �T�y�p�e�O�R�M� �a�n�d� �S�w�a�g�g�e�r�.�
�
�-� ��g�e�n�e�r�a�t�e� �<�r�e�s�o�u�r�c�e�>�
�:� �G�e�n�e�r�a�t�e�s� �a� �n�e�w� �r�e�s�o�u�r�c�e� �(�e�.�g�.�,� �m�o�d�u�l�e�,� �s�e�r�v�i�c�e�,� �c�o�n�t�r�o�l�l�e�r�)�.�
�
�
�
�#�#� �E�x�a�m�p�l�e�
�
�
�
��
��b�a�s�h�
�
�n�e�s�t�-�b�o�o�t�s�t�r�a�p�-�c�l�i� �n�e�w� �m�y�-�n�e�s�t�j�s�-�a�p�p�
�
�c�d� �m�y�-�n�e�s�t�j�s�-�a�p�p�
�
�n�p�m� �r�u�n� �s�t�a�r�t�
�
�
��
�
�
�
�
�#�#� �C�o�n�t�r�i�b�u�t�i�n�g�
�
�
�
�C�o�n�t�r�i�b�u�t�i�o�n�s� �a�r�e� �w�e�l�c�o�m�e�!� �P�l�e�a�s�e� �o�p�e�n� �a�n� �i�s�s�u�e� �o�r� �s�u�b�m�i�t� �a� �p�u�l�l� �r�e�q�u�e�s�t�.�
�
�
�
�#�#� �L�i�c�e�n�s�e�
�
�
�
�T�h�i�s� �p�r�o�j�e�c�t� �i�s� �l�i�c�e�n�s�e�d� �u�n�d�e�r� �t�h�e� �M�I�T� �L�i�c�e�n�s�e�.�
�
�