1.0.0-alpha.1 โข Published 3 years ago
@cbim/create-react-nest-app v1.0.0-alpha.1
๐ Table of Contents
๐ Feature
A production ready cbim application boilerplate.
- Support react hooks & HMR.
- All executable files use typescript.
- Powerful custom development environment.
- Support lint & test & code inspection & automatic style unification based on git hooks.
- Out-of-the-box business packaging.
- Component based on antd.
- Server based on Nest.js.
- State store based on mobx-state-tree.
- Package management powered by pnpm which monorepo is natively supported.
- 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
- Migrate webapck 4 to webpack 5
- Built-in scaffold
- Add theme system
๐ 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
1.0.0-alpha.1
3 years ago
1.0.0-alpha.0
3 years ago