Skip to content

☕ PWA(Progressive Web App) project development environment startup configuration. | PWA 项目开发环境启动配置。

License

Notifications You must be signed in to change notification settings

wang1212/create-web-app

Repository files navigation

Create Web App

LICENSE NPM VERSION DOWNLOAD LAST COMMIT GITHUB PACKAGE CI Commitizen friendly Codacy Badge

English | 简体中文

☕ Create PWA(Progressive Web App) project development environment startup configuration.

This package is now pure ESM, read this.

Starting with version 0.3.0, flow.js will no longer be used, and typescript will be used instead.

Template type

Support the following types:

  • javascript
  • react.js(or Official, 👉 now more recommended next.js 🚀)

javascript type builds a PWA that doesn't depend on any development framework, while react.js type builds PWA based on React framework ecosystems such as React.js, Redux.js, and React Router.

Usage

  • You don't need to install the package on your computer, you can use it and run:

    npm init @wang1212/web-app
    npx @wang1212/create-web-app // same as the previous line
  • You can also install the package on your computer, use it to run:

    // install this package
    npm install -g @wang1212/create-web-app
    
    // now, use it to create a web app project
    create-web-app

Note: create-web-app has an alias create-pwa.

Details

For more information, read templates/*app/README.md file contents.

Development Guidelines

Git Commit Message Format

Adopt community commit format best practices:

# Before
git commit

# Now
npm run commit

This constraint relies on tools commitizen and commitlint provided by the community.

npm publish

The version management of this module adopts the specifications recommended by the community Semantic Versioning. Follow version changes and maintain a CHANGELOG.md(Learn why).

# Update version and generate changelog before publishing to npm repository
npm run release # npm run release -- --first-release
# Or, preview
npm run release -- --dry-run

# Then
npm publish # npm publish --access public

These jobs are done with the help of standard-version tool provided by the community.

Related

If you want to develop a node module package (library), maybe you can take a look:

create-lib-starter

Or, other similar things:

awesome-template