About

ParrotEnv is a CLI framework that quickly sets up a development environment for your JavaScript-based project. It automates the installation and configuration of common dependencies, editor configurations, linters, code formatting, test tools and so on. Allowing you to focus on coding instead of repetitive setup steps. ParrotEnv provides standardized configurations for the language's essential development tools, that follows industry best practices, helping you scaffold your project quickly. ParrotEnv is open-source and available under the MIT license with additional Copyright clauses, allowing you to use it freely in your projects while respecting the author's copyright.

Installation

npm i parrotenv -g # recommended

Usage

If you have installed ParrotEnv globally, you can use the command bellow to start the CLI:

parrotenv

# or the shortcut
pe

Or if you do want to install it locally with the npm i parrotenv, you can just use the npx commands after installing it on your project:

npx parrotenv

# or the shortcut
npx pe

License

Copyright (c) 2023 Rafael Fernandes de Lima

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use, copy, modify and/or merge the Software, subject to the following conditions:

1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

2. Any contributions made by you to the Software shall be a fork of the original project on GitHub, and all changes to the Software made by you must be contributed back to the original project under the same license.

3. You may not distribute, sublicense, or sell copies of the Software, modified or not, without express permission from Rafael Fernandes de Lima.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.