Skip to content

Commit 0aac8e2

Browse files
committed
readme file updated for create-servest
1 parent cb463de commit 0aac8e2

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

packages/create-servest/README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# create-servest <a href="https://npmjs.com/package/create-servest"><img src="https://img.shields.io/npm/v/create-servest" alt="npm package"></a>
22

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.
44

5-
> This project draws inspiration from [create-vite](https://www.npmjs.com/package/create-vite), adapting the concept for backend development.
5+
## Features
66

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
912

1013
### Using NPM:
1114

@@ -41,10 +44,10 @@ You can directly specify the project name and template via CLI options:
4144

4245
```bash
4346
# 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
4548

4649
# 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
4851
```
4952

5053
> Tip: Use `.` as the project name to scaffold in the current directory:
@@ -76,19 +79,15 @@ npm create servest@latest . -- --template express-basic-ts
7679

7780
## Addons
7881

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:
8083

8184
```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
8386
```
8487

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.
9089

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.
9291
9392
---
9493

0 commit comments

Comments
 (0)