AutoEnvSetter is a tool that allows you to easily build a Javascript/Typescript (+react, etc.) development environment.
To use AutoEnvSetter, you can run the script locally by following these steps:
- Create your own project directory and move to the project directory.
mkdir your/project/directory && cd your/project/directory
-
Download the ZIP file from here to the root of your project directory.
-
Unzip the file. Make sure the AutoEnvSetter folder is set up as follows
🗂 (Project directory)
└── 🗂 AutoEnvSetter
├── 🗂 bin
│ └── 📄 install.sh
├── ...
- Run
sh AutoEnvSetter/bin/install.sh
.
sh AutoEnvSetter/bin/install.sh
- If you choose playwright for your test, you will see
TODO: Please edit webServer in the playwright.config.ts file as follows.
Please follow the instructions. Please follow the instructions.
You can pass in the following arguments:
--package_manager=[package manager]
: Specify the package manager you want to use (e.g.--package_manager=yarn
). The default value ispnpm
.--language=[language]
: Specify the language you want to use (e.g.--language=javascript
). The default value istypescript
.--framework=[framework]
: Specify the framework you want to use (e.g.--framework=react
). The default value isnone
.--formatter=[formatter]
: Specify the code formatter you want to use (e.g.--formatter=prettier
). The default value isprettier
.--linter=[linter]
: Specify the linter you want to use (e.g.--linter=eslint
). The default value iseslint
.--bundler=[bundler]
: Specify the module bundler you want to use (e.g.--bundler=webpack
). The default value iswebpack
.--test=[test]
: Specify the test you want to use (e.g.--test=playwright
). The default value isplaywright
.
The linter variable can accept multiple values separated by a comma, such as --linter=eslint,stylelint
. If multiple linters are specified, the script will configure each linter accordingly.
AutoEnvSetter currently supports the following options:
- Package manager:
npm
,yarn
,pnpm
- Programming Lnguage:
javascript
,typescript
- Framework:
none
,react
- Linter:
none
,eslint
,stylelint
- Formatter:
none
,prettier
- Bundler:
none
,webpack
- Test:
none
,jest
,playwright
sh AutoEnvSetter/bin/install.sh
sh AutoEnvSetter/bin/install.sh --framework=react
sh AutoEnvSetter/bin/install.sh --framework=react --linter=eslint,stylelint
AutoEnvSetter is compatible with macOS and Linux operating systems. Compatibility with Windows has not been confirmed at this time.
AutoEnvSetter requires the following:
- Bash
- Curl
We plan to continue developing AutoEnvSetter to add new features and support for more languages, frameworks, and tools. Some features we plan to add include:
- Support for additional languages and frameworks
- Integration with testing frameworks
- Automatic deployment scripts
- Works like a brew installer (without downloading)
Stay tuned for updates!
We welcome contributions to AutoEnvSetter! To contribute, please follow these steps:
- Fork the project on GitHub.
- Make your changes and commit them with clear commit messages.
- Push your changes to your forked repository.
- Submit a pull request.
- We will review your changes and merge them if they are a good fit for the project.
This project is licensed under the MIT License. See the LICENSE file for details.