|
1 | 1 | # create-servest <a href="https://npmjs.com/package/create-servest"><img src="https://img.shields.io/npm/v/create-servest" alt="npm package"></a> |
2 | 2 |
|
3 | | -## Scaffolding Your First Backend Project |
| 3 | +`create-servest` is a scaffolding tool for quickly setting up modern backend projects. Inspired by [create-vite](https://vitejs.dev/), it allows you to bootstrap projects with or without addons in a streamlined way. |
4 | 4 |
|
5 | | -> This project draws inspiration from [create-vite](https://www.npmjs.com/package/create-vite), adapting the concept for backend development. |
| 5 | +## Features |
6 | 6 |
|
7 | | -> **Compatibility Note:** |
8 | | -> Servest requires [Node.js](https://nodejs.org/en/) version 18+. Some templates may require a higher Node.js version. |
| 7 | +- Quickly scaffold a backend project |
| 8 | +- Optional addons for extended functionality |
| 9 | +- Works seamlessly with the `servest` package to integrate additional features |
| 10 | + |
| 11 | +## Installation |
9 | 12 |
|
10 | 13 | ### Using NPM: |
11 | 14 |
|
@@ -41,10 +44,10 @@ You can directly specify the project name and template via CLI options: |
41 | 44 |
|
42 | 45 | ```bash |
43 | 46 | # Scaffold an Express MVC TypeScript project non-interactively |
44 | | -npm create servest@latest my-backend-app -- --template express-mvc-ts |
| 47 | +npm create servest@latest servest-project -- --template express-mvc-ts |
45 | 48 |
|
46 | 49 | # With addons |
47 | | -npm create servest@latest my-backend-app -- --template express-mvc-ts -a eslint-prettier mongoose |
| 50 | +npm create servest@latest servest-project -- --template express-mvc-ts -a f-auth f-articles mongoose eslint-prettier |
48 | 51 | ``` |
49 | 52 |
|
50 | 53 | > Tip: Use `.` as the project name to scaffold in the current directory: |
@@ -76,19 +79,15 @@ npm create servest@latest . -- --template express-basic-ts |
76 | 79 |
|
77 | 80 | ## Addons |
78 | 81 |
|
79 | | -After scaffolding, you can automatically install additional utilities using the `-a` or `--addons` flag: |
| 82 | +You can automatically include additional utilities during scaffolding using the `-a` or `--addons` flag: |
80 | 83 |
|
81 | 84 | ```bash |
82 | | -npm create servest@latest -- --template express-mvc-ts -a eslint-prettier mongoose |
| 85 | +npm create servest@latest -- --template express-mvc-ts -a f-auth mongoose eslint-prettier lint-staged |
83 | 86 | ``` |
84 | 87 |
|
85 | | -This will scaffold the `express-mvc-ts` template and run: |
86 | | - |
87 | | -```bash |
88 | | -npx add servest@latest eslint-prettier mongoose |
89 | | -``` |
| 88 | +This will scaffold the express-mvc-ts project and install the required npm packages to enhance your development workflow. |
90 | 89 |
|
91 | | -> Note: If any addon fails, the others will still be executed. You can rerun failed addons manually. |
| 90 | +> Note: If any addon fails, the remaining ones will still be applied. You can re-run the failed addons manually later. |
92 | 91 |
|
93 | 92 | --- |
94 | 93 |
|
|
0 commit comments