—— Web Full-Stack Boilerplate ——

📝 Table of Contents

• Feature
• Getting Started
• Running the tests
• Deployment
• Road Map
• Acknowledgments
• Compatibility

🚀 Feature

A production ready web full-stack boilerplate.

1. Support react hooks & HMR.
2. All executable files use typescript.
3. Powerful custom development environment.
4. Support lint & test & code inspection & automatic style unification based on git hooks.
5. Out-of-the-box business packaging.
   1. Component based on antd.
   2. Server based on Nest.js.
   3. State store based on mobx-state-tree.
   4. Package management powered by pnpm which monorepo is natively supported.
6. Support multiple environment toml type config.

More new features are on the way...

🏁 Getting Started

Prerequisites

Install NodeJs and recommend to use nvm for version management and nrm for registry management. We use pnpm as our daily package manager

npm i pnpm -g

npm i nrm -g

Installing

A step by step series of examples that tell you how to get a development env running.

Say what the step will be

pnpm install

End with an example of getting some data out of the system or using it for a little demo.

Developing

pnpm dev:web

pnpm dev:node

🔧 Running the tests

Explain how to run the automated tests for this system.

Coding style tests

Explain what these tests test and why

pnpm lint

🚀 Deployment

Add additional notes about how to deploy this on a live system.

pnpm build

🗺 Road Map

1. Migrate webapck 4 to webpack 5
2. Built-in scaffold
3. Add theme system
4. Support micro-frontend

🎉 Acknowledgements

• About commit
  • Conventional Commits Spec - A specification for adding human and machine readable meaning to commit messages
  • Angular Git Commit Guidelines - A git commit guidelines for angular developer teams.

🚨 Compatibility

IE/Edge	Firefox	Chrome	Safari	Opera	Electron
IE11, Edge	last 2 versions	last 2 versions	last 2 versions	last 2 versions	last 2 versions

Reference

react-typescript-boilerplate by tjx66

License

MIT License. Copyright © 2021 NNNaix.