1.0.0 โ€ข Published 4 years ago

aio-project-initializer v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

npm Status GitHub issues GitHub forks GitHub stars GitHub pull requests GitHub License

๐Ÿ’ก Features

  1. Initialize a GIT repository
  2. Create .gitignore file with most used entries
  3. Initialize a working project
    • Front End
    • Back End
    • Full Stack
  4. Configure all the essential tools
    • Eslint
    • Prettier
    • Webpack
    • Babel
  5. Perfectly compatible with
    • TypeScript
    • JavaScript
  6. Ask questions and works according to the choices
  7. You have complete control over the configuration
  8. Installs all packages as well
  9. Uses your preferred package manager
  10. Inline comments in files to help you adapt the change

๐Ÿ”ง Configuration

  • Change the file extension of entry key in webpack/common.js according to your selected language (.tsx/.jsx) or it will throw errors.

โ›๏ธ Built with

  • Inquirer
  • Listr
  • Fs Extra
  • Execa
  • Chalk

๐Ÿ Getting Started

Follow all these instructions and learn the best way to take benefits from this package.

๐Ÿ“š Prerequisite

  • npm/yarn

๐Ÿงฐ Installation & Consuming

  1. Global Installation

    npm i aio-project-initializer -g

    Note: Global installation is not possible with yarn v2 as far as I know, (please guide me if I am wrong). If you are using yarn v1 then use yarn global add aio-project-initializer. RUN THIS IN A EMPTY DIRECTORY I REPEAT RUN THIS IN EMPTY DIRECTORY OR IT WILL THROW ERROR & USE GLOBAL METHOD OR USE NPX NO PER PROJECT INSTALLATION.

  2. Command to initialize project

    • Global installation

      aio-initialize
    • Using NPX

      npx aio-project-initializer

๐ŸŽˆ Usage

The sole motive of this package is to improve Developer Experience. The package is made to save time initializing & configuring a new project with all the tools. The tool will ask you certain questions, prepare a tasks list according to you choice and run all of them, hence you get your project perfectly working and configured. You just need to focus on your awesome project.

โœ๏ธ Authors

๐Ÿ“– Contributing

"In real open source, you have the right to control your own destiny." - Linus Torvalds

Contributions are what makes the open-source community an amazing place. Any contributions you make are greatly appreciated.

๐Ÿ’ณ License

Distributed under the MIT License. See LICENSE for more information.

๐Ÿงฌ Resources

๐ŸŽ‰ Acknowledgement

๐Ÿ‘‹ EndNote

Star this project if you like it also you won't miss it when you need it.