/create-exposed-app

App generator with everything exposed for maximum control (powered by TypeScript, Babel, Jest, ESLint, Prettier, CircleCI, and more)

Primary LanguageTypeScriptMIT LicenseMIT

create-exposed-app

Version Downloads Last commit Build License PRs Welcome Code of conduct

App generator with everything exposed for maximum control (powered by TS, Babel, Jest, ESLint, Prettier, CircleCI, and more)


Like zero-config? Get out!

Generate a flexible starting point for your app, where config files and scripts are in-your-face and ready to adapt to your needs.

Because every app is unique.

Go for it:

npm init exposed-app

command demo

What's included?

  • 🔧 TypeScript, Babel, Jest, ESLint, Prettier, and more
    • Configured with sensible defaults
    • All optional and tweakable
  • 🚀 CI/CD
    • Automatic validation in pull requests, powered by CircleCI
    • Automatic versioning and release to NPM after merging to master, powered by semantic-release
  • đź“– Documentation templates
  • 🎉 More!
    • Automatically format and test changed files, powered by lint-staged
    • VS Code settings

Examples

Usage

Run the following command and follow the prompts:

npm init exposed-app

You can also invoke the app with arguments. For example:

npx create-exposed-app \
  --project-package-name="my-awesome-project" \
  --project-overview="Does awesome stuff" \
  --side="server" \
  --author-name="Bruce Wayne" \
  --author-email="bruce.wayne@gmail.com" \
  --author-github="batman" \
  --author-website="https://batman.com"

Run npx create-exposed-app --help for details.

Inspiration

Credits

This project is authored and maintained by Matt Turnbull (iamturns.com / @iamturns).

Thank you to all contributors.

License

Open-source under MIT License.

FAQ

Uh oh, something went wrong!

Sorry about that. Please submit a bug report using the GitHub issue tracker.

I wish something was different…

Keen to hear all ideas! Create an enhancement request using the GitHub issue tracker.

Can I contribute code?

Yes please! See DEVELOPING.md.

My question isn't answered :(

Ask away using the GitHub issue tracker.