https://github.com/iamturns/create-exposed-app
App generator with everything exposed for maximum control (powered by TypeScript, ESBuild, Jest, ESLint, GitHub Actions, Prettier, and more)
https://github.com/iamturns/create-exposed-app
app-generator create-app esbuild generator javascript nodejs starter-kit starter-project typescript
Last synced: 3 months ago
JSON representation
App generator with everything exposed for maximum control (powered by TypeScript, ESBuild, Jest, ESLint, GitHub Actions, Prettier, and more)
- Host: GitHub
- URL: https://github.com/iamturns/create-exposed-app
- Owner: iamturns
- License: mit
- Created: 2018-12-30T06:16:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-20T19:11:27.000Z (6 months ago)
- Last Synced: 2025-01-04T03:08:07.875Z (5 months ago)
- Topics: app-generator, create-app, esbuild, generator, javascript, nodejs, starter-kit, starter-project, typescript
- Language: EJS
- Homepage:
- Size: 2.89 MB
- Stars: 405
- Watchers: 4
- Forks: 62
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# create-exposed-app
[](https://www.npmjs.com/package/create-exposed-app?activeTab=versions) [](https://www.npmjs.com/package/create-exposed-app) [](https://github.com/iamturns/create-exposed-app/graphs/commit-activity) [](https://actions-badge.atrox.dev/iamturns/create-exposed-app/goto?ref=master) [](https://coveralls.io/github/iamturns/create-exposed-app?branch=master) [](https://github.com/iamturns/create-exposed-app/blob/master/LICENSE) [](https://github.com/iamturns/create-exposed-app#can-i-contribute-code) [](https://github.com/iamturns/create-exposed-app/blob/master/CODE_OF_CONDUCT.md)
> App generator with everything exposed for maximum control (powered by TypeScript, ESBuild, Jest, ESLint, GitHub Actions, Prettier, 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:
```bash
npm init exposed-app
```
## What's included?
- 🏆 Powered by the usual suspects: [TypeScript](https://www.npmjs.com/package/debug), [Jest](https://jestjs.io), [ESLint](https://eslint.org)
- 📦 TS → JS, powered by [esbuild](https://github.com/evanw/esbuild)
- It's so fast! With tree shaking too
- Outputs CJS, ESM, and `d.ts` files
- 🚀 CI/CD, powered by [GitHub Actions](https://github.com/features/actions)
- Publishing, versioning, and changelog generation, powered by [Release Please](https://github.com/googleapis/release-please)
- Automatically format code, and commit changes back to the repo
- PRs display a code coverage report, powered by [Coveralls](https://coveralls.io)
- 🎀 Format code, powered by [Prettier](http://prettier.io), [EditorConfig](https://editorconfig.org), [import-sort](https://github.com/renke/import-sort), [sort-package-json](https://github.com/keithamus/sort-package-json), [doctoc](https://github.com/thlorenz/doctoc)
- 📚 Documentation templates
- README.md, CHANGELOG.md, CODE_OF_CONDUCT.md, DEVELOPING.md, MAINTAINING.md, and LICENSE
- [GitHub templates](https://help.github.com/articles/about-issue-and-pull-request-templates/) for PRs and issues
- [Architectural Decision Records](https://adr.github.io/)
- 🎉 More!
- VS Code recommended extensions
- Bootstrap with some classics: [dotenv](https://www.npmjs.com/package/dotenv), [debug](https://www.npmjs.com/package/debug)
## Setup
```bash
npm install @iamturns/create-exposed-app
```
## Usage
Run the following command and follow the prompts:
```bash
npm init exposed-app
```
You can also invoke the app with arguments. For example:
```bash
npx create-exposed-app \
--packageName="my-awesome-project" \
--npmScope="@example" \
--oneLiner="Does awesome stuff" \
--authorName="Bruce Wayne" \
--authorEmail="[email protected]" \
--authorGithub="batman" \
--authorTwitter="TheRealBatman" \
--authorWebsite="https://batman.com"
```
## Credits
This project is authored and maintained by Matt Turnbull ([iamturns.com](https://iamturns.com) / [@iamturns](https://twitter.com/iamturns)).
A big thank you to all [contributors](https://github.com/iamturns/create-exposed-app/graphs/contributors) 🏆
## License
Open-source under [MIT License](https://github.com/iamturns/create-exposed-app/blob/master/LICENSE).
## FAQ
- [Uh oh, something went wrong!](#uh-oh-something-went-wrong)
- [I wish something was different…](#i-wish-something-was-different)
- [Can I contribute code?](#can-i-contribute-code)
- [My question isn't answered :(](#my-question-isnt-answered-)
### Uh oh, something went wrong!
Sorry about that. Please submit a bug report using the [GitHub issue tracker](https://github.com/iamturns/create-exposed-app/issues).
### I wish something was different…
Keen to hear all ideas in [GitHub discussions](https://github.com/iamturns/create-exposed-app/discussions).
### Can I contribute code?
Yes please! See [DEVELOPING.md](./DEVELOPING.md).
### My question isn't answered :(
Ask away in [GitHub discussions](https://github.com/iamturns/create-exposed-app/discussions).