Skip to content

A front-end scaffolding that supports Webpack / Vite+TypeScript/JavaScript+React

License

Notifications You must be signed in to change notification settings

Athena-FE/pre-me-cli

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#quick react project generator

GitHub package.json version npm GitHub code size in bytes GitHub commit activity GitHub last commit GitHub language count node-current

A highly integrated React project generation scaffold, so that you don't have to worry about installing dependencies, and you don't have to repeatedly modify configuration files for custom configuration. Currently, Webpack and Vite are supported as project tools to start, and Javascript and Typescript are supported.

Features 🎉

Really one step in place 👏

  1. Both webpack and react templates now support sass, less, stylus, which can be used directly after the installation is completed;
  2. Simplify the webpack template configuration, update it to webpack5 and use the cache function to improve the secondary startup speed;
  3. Add eslint for code verification and code repair;
  4. Use husky to add git commit detection;
  5. Use npm run commit to implement canonical command submission;
  6. Use npx to always keep templates updated or install with npm to keep your favorite version in your local repository;
  7. Use yarn for package management to avoid version problems and dependency errors;

Highly self-modifying 😯

  1. Expose all configurable items to users to support more pluggable optimization and custom operations.
  2. Provide users with an easier-to-use project template.

use 🔧

method one:

  • Install globally: npm install pre-me-cli -g
  • Create a project template with the command: Create project pre-me-cli init [projectName]
    • webpack-ts: typescript project with webpack as a tool;
    • webpack-js: javascript project with webpack as a tool;
    • vite-ts: vite is a typescript project for tools;
    • vite-js: a javascript project with vite as a tool;

Method 2 (to keep your templates always up to date)

  • npx install: npx pre-me-cli init [projectName]

    • webpack-ts
    • webpack-js
    • vite-ts
    • vite-js

Startup project

  • Enter the project and install dependencies: cd projectName && yarn
  • Start the project: yarn dev or npm run dev

You are very welcome to provide some feasible suggestions and help, and look forward to your joining~

About

A front-end scaffolding that supports Webpack / Vite+TypeScript/JavaScript+React

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 80.9%
  • TypeScript 7.9%
  • CSS 5.8%
  • HTML 5.4%