You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-7Lines changed: 8 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -14,29 +14,30 @@ npm i -g fastify-swc-typescript-server-bootstrap-cli
14
14
15
15
## Usage
16
16
17
-
After installation, bootstrap a new Fastify SWC server project using the command:
17
+
After installation, bootstrap a new Fastify SWC server project using the `fastify-swc-server`command:
18
18
19
19
```bash
20
20
fastify-swc-server [project-name]
21
21
```
22
22
23
-
Replace `[project-name]` with the intended name for the project. This creates a new directory with the specified name, clones the Fastify SWC server setup, and configures the project accordingly.
23
+
Replace `[project-name]` with the intended name for the project. This creates a new directory with the specified name, clones the Fastify SWC server repo, and configures the project accordingly.
24
24
25
25
## Current Features
26
26
27
-
- Clones a Fastify SWC Jest server boilerplate from [this repository](https://github.com/mattfsourcecode/fastify-swc-typescript-server).
28
-
- Removes the original `.git` directory from the cloned repository and initializes a new git repository, allowing for a clean version control start.
27
+
- Clones a boilerplate from [this repository](https://github.com/mattfsourcecode/fastify-swc-typescript-server).
28
+
- Removes the original `.git` directory and initializes a new git repository for a clean version control start.
29
29
- Updates the `package.json` with the specified project name and resets the author value to an empty string.
Contributions are welcome! If you have ideas or improvements, please open an issue first for discussion before submitting a pull request.
37
+
Contributions are welcome! If you have ideas for improvements, please open an issue first for discussion before submitting a pull request.
37
38
38
-
The [npm module's codebase](https://github.com/mattfsourcecode/fastify-swc-typescript-server-bootstrap-cli) uses a testing suite with [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/), integrating [Husky](https://typicode.github.io/husky/) as a pre-commit [git hook](https://git-scm.com/book/ms/v2/Customizing-Git-Git-Hooks), ensuring all tests pass before staged changes can be committed.
39
+
NOTE: The [npm module's codebase](https://github.com/mattfsourcecode/fastify-swc-typescript-server-bootstrap-cli) uses a testing suite with [Mocha](https://mochajs.org/) and [Chai](https://www.chaijs.com/), integrating [Husky](https://typicode.github.io/husky/) as a pre-commit [git hook](https://git-scm.com/book/ms/v2/Customizing-Git-Git-Hooks) to ensure all tests pass before staged changes can be committed.
39
40
40
41
You can report issues or start discussions here: [Open an issue](https://github.com/mattfsourcecode/fastify-swc-typescript-server-bootstrap-cli/issues)
41
42
42
-
For contributions and issues relating to the [codebase cloned](https://github.com/mattfsourcecode/fastify-swc-typescript-server) with the `fastify-swc-server` command, [open an issue here](https://github.com/mattfsourcecode/fastify-swc-typescript-server/issues).
43
+
For contributions and issues regarding the [codebase cloned](https://github.com/mattfsourcecode/fastify-swc-typescript-server) with the `fastify-swc-server` command, [open an issue here](https://github.com/mattfsourcecode/fastify-swc-typescript-server/issues).
0 commit comments