aio-project-initializer
v1.0.0
Published
A CLI to initialize a project, configure & setup all the tools and do all the heavy lifting on your behalf
Downloads
4
Readme
💡 Features
- Initialize a GIT repository
- Create
.gitignore
file with most used entries - Initialize a working project
- Front End
- Back End
- Full Stack
- Configure all the essential tools
- Eslint
- Prettier
- Webpack
- Babel
- Perfectly compatible with
- TypeScript
- JavaScript
- Ask questions and works according to the choices
- You have complete control over the configuration
- Installs all packages as well
- Uses your preferred package manager
- Inline comments in files to help you adapt the change
🔧 Configuration
- Change the file extension of
entry
key inwebpack/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
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.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
- @DeeshanSharma - Idea & Initial Work
📖 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.