Build Any App

Generate template of your apps dynamically.

Build-any-app can run in interactive mode with the option -i through which it prompts for an option if it's not provided. Non-interactive mode can be used in scripts. Also, you can run the app in debug mode with --debug switch.

Prompts

Following common options can be provided for your application

--name/-n:                  Author Name
--repo-name/-r              Repository Name
--description/-d            Project Description
--package-name/-p           Package name
--private-pkg               Is your project private
--private-repo              Is your repo private
--publish                   Do you wish to publish your project
--provider                  Git provider. Choices - github, gitlab
--license/-l                License
--static-tools/-t           The static tools you want to use. Multiple Choices - typescript, eslint, prettier, jest, commitizen, huksy, None
--code-quality-tools/-c     The code quality tools you want to use. Multiple Choices - codecov, code-climate, None
--cicd                      The CI/CD tool you want to use. Choices - github-actions, circleci, None
--token                     Git provider token
--npm-token                 NPM token (if you want to publish your package)
--debug                     Run build-any-app in debug mode
--interactive/-i            Run build-any-app in interactive mode

Following options can be provided for a web application

--framework/-f              The framework you want to use for your web application. Choices - react
--ui/-u                     The UI library you want to use for your web application. Choices - react-bootstrap
--stateLibrary/-s           The global state management library you want to use for your web application. Choices - redux, zustand

Example

build-any-app web

build-any-app web -i -n "John Smith" -r my-app

build-any-app web -n "John Smith" -r my-app --private --publish -i

build-any-app web -f react --cicd github-actions -n "John Doe" -r my-app -u react-bootstrap -s zustand -t typescript eslint jest prettier commitizen husky --privatePkg false

build-any-app web -i -d "Build any app project" -p my-package-name --cicd github-actions --private-package false --private-repo false --publish true --provider github --token <github_token> --npm-token -t eslint prettier typescript jest commitizen husky -c code-climate codecov --license mpl-2.0 -f react -u react-bootstrap -s redux -r my-app2

Details

Following options are only used if a git provider is provided

--token, --license, --private-repo, --cicd

Following options are only used if a git provider is provided and a CI/CD tool is provided

--publish, --code-quality-tools

Following options are only used if a git provider is provided, a CI/CD tool is provided and if you choose to publish the package

--name, --description, --package-name, --private-pkg, --npm-token

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

Apache License 2.0