Giter Club home page Giter Club logo

autoenvsetter's Introduction

AutoEnvSetter

AutoEnvSetter is a tool that allows you to easily build a Javascript/Typescript (+react, etc.) development environment.

Usage

To use AutoEnvSetter, you can run the script locally by following these steps:

  1. Create your own project directory and move to the project directory.
mkdir your/project/directory && cd your/project/directory
  1. Download the ZIP file from here to the root of your project directory.

  2. Unzip the file. Make sure the AutoEnvSetter folder is set up as follows

🗂 (Project directory)
└── 🗂 AutoEnvSetter
    ├── 🗂 bin
    │   └── 📄 install.sh
    ├── ...
  1. Run sh AutoEnvSetter/bin/install.sh.
sh AutoEnvSetter/bin/install.sh
  1. 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.

Arguments

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 is pnpm.
  • --language=[language]: Specify the language you want to use (e.g. --language=javascript). The default value is typescript.
  • --framework=[framework]: Specify the framework you want to use (e.g. --framework=react). The default value is none.
  • --formatter=[formatter]: Specify the code formatter you want to use (e.g. --formatter=prettier). The default value is prettier.
  • --linter=[linter]: Specify the linter you want to use (e.g. --linter=eslint). The default value is eslint.
  • --bundler=[bundler]: Specify the module bundler you want to use (e.g. --bundler=webpack). The default value is webpack.
  • --test=[test]: Specify the test you want to use (e.g. --test=playwright). The default value is playwright.

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.

Supported options

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

Example Usage

pnpm+typescript+eslint+prettier+webpack+playwright

sh AutoEnvSetter/bin/install.sh

pnpm+typescript+react+eslint+prettier+webpack+playwright

sh AutoEnvSetter/bin/install.sh --framework=react

pnpm+typescript+react+eslint+stylelint+prettier+webpack+playwright

sh AutoEnvSetter/bin/install.sh --framework=react --linter=eslint,stylelint

Compatibility

AutoEnvSetter is compatible with macOS and Linux operating systems. Compatibility with Windows has not been confirmed at this time.

Requirements and Dependencies

AutoEnvSetter requires the following:

  • Bash
  • Curl

Future Development

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!

Contributing

We welcome contributions to AutoEnvSetter! To contribute, please follow these steps:

  1. Fork the project on GitHub.
  2. Make your changes and commit them with clear commit messages.
  3. Push your changes to your forked repository.
  4. Submit a pull request.
  5. We will review your changes and merge them if they are a good fit for the project.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

autoenvsetter's People

Contributors

hoshimurayuto avatar

Watchers

 avatar

autoenvsetter's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.