https://github.com/typegoose/typegoose-examples
Project Examples with integrations of other packages
https://github.com/typegoose/typegoose-examples
Last synced: 6 months ago
JSON representation
Project Examples with integrations of other packages
- Host: GitHub
- URL: https://github.com/typegoose/typegoose-examples
- Owner: typegoose
- License: mit
- Created: 2022-11-28T12:07:41.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-12-15T12:16:31.000Z (8 months ago)
- Last Synced: 2025-12-18T13:50:04.295Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 482 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Typegoose Examples
This Repository contains Example projects with basic showcases and integrations with other packages.
See the [`examples`](./examples/) directory for all examples available.
## Setup
Thanks to yarn and jest, the setup is quite simple:
```sh
git clone https://github.com/typegoose/typegoose-examples.git --depth 10
cd typegoose-examples
yarn install
# Verify that all projects are working
yarn run test
```
## Add a new example
Adding new examples is simple thanks to the boilerplate [`basic`](./examples/basic/) example, just clone it and modify the clone:
```sh
# Starting point is in the root of the project (where the current README exists)
cd examples/
cp -R ./basic ./your-new-example
cd your-new-example
# Apply all modifications you want to the new example
# Verify your example is working
# while being in the example, only that example's tests are run
yarn run test
# No extra addition anywhere else is needed
# And root-level testing also works out-of-the-box
cd ../../
yarn run test
# or while still being in the example
yarn --cwd ../../ test
```