Update README.md
This commit is contained in:
parent
ce303ef231
commit
427adb32ac
1 changed files with 33 additions and 9 deletions
40
README.md
40
README.md
|
@ -1,20 +1,44 @@
|
||||||
# TS Fastify Example
|
# TypeScript Fastify Starter Template
|
||||||
|
|
||||||
This is just an example/template to get you started with Fastify and TypeScript. It starts off using EJS, but you can use something else if you'd like.
|
This template is designed to help you get started with Fastify and TypeScript. By default, it uses **EJS** as the templating engine, but feel free to replace it with any other engine that suits your project.
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
To start the project, you can run either `start.bat` or `start.sh`.
|
### For Windows:
|
||||||
|
Use the following commands via `start.bat`:
|
||||||
|
|
||||||
## Cleanup
|
- **Start the project:** `start.bat`
|
||||||
|
- **Clean up the project:** `start.bat clean`
|
||||||
|
- **Change mode:** `start.bat mode <mode>`
|
||||||
|
|
||||||
You can clean up your project with the following commands:
|
### For Unix/Linux:
|
||||||
|
Use the following commands via `start.sh`:
|
||||||
|
|
||||||
- **Windows:** `start.bat clean`
|
- **Start the project:** `start.sh`
|
||||||
- **Unix/Linux:** `start.sh clean`
|
- **Clean up the project:** `start.sh clean`
|
||||||
|
- **Change mode:** `start.sh mode <mode>`
|
||||||
|
|
||||||
Have fun - **Creations** // **creations@creations.works**
|
### Mode Options:
|
||||||
|
You can set the following modes:
|
||||||
|
|
||||||
|
- `dev` or `development`
|
||||||
|
- `prod` or `production`
|
||||||
|
|
||||||
|
## Package Manager Support
|
||||||
|
|
||||||
|
You can switch the package manager for the project with the following allowed managers:
|
||||||
|
|
||||||
|
- **bun**
|
||||||
|
- **npm**
|
||||||
|
- **yarn**
|
||||||
|
- **pnpm**
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the MIT License - see the [LICENSE](https://creations.works/creations/TSFastifyExample/src/branch/main/LICENCE) file for details.
|
This project is licensed under the MIT License - see the [LICENSE](https://creations.works/creations/TSFastifyExample/src/branch/main/LICENCE) file for details.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Have fun!
|
||||||
|
**Creations**
|
||||||
|
**creations@creations.works**
|
||||||
|
|
Loading…
Reference in a new issue