Skip to content

Commit

Permalink
Merge pull request #337 from Josuto/improve_nestjs_example_documentation
Browse files Browse the repository at this point in the history
docs: IImprove NestJS example documentation
  • Loading branch information
Josuto authored Dec 7, 2024
2 parents fcb8c41 + a64cf03 commit 4ee9b81
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
21 changes: 21 additions & 0 deletions examples/nestjs-mongoose-book-manager/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Josu Martinez

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
14 changes: 11 additions & 3 deletions examples/nestjs-mongoose-book-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,19 @@ A book may be of type `Book` or any of its subtypes i.e., `PaperBook` and `Audio

## Installation

Assuming that you have already [installed NestJS](https://docs.nestjs.com/first-steps) in your local machine, first you
need to install of the project dependencies by running the following command:
This example depends on NestJS and the `monguito` package included in the root folder of the Monguito repository. Hence, before
installing any dependency, (1) make sure that you have [NestJS installed in your machine](https://docs.nestjs.com/first-steps)
and (2) build `monguito` from the root folder of your local repository:

```bash
$ yarn install
$ yarn build
```

Then, you can install of the NestJS sample project dependencies by running the following command (from
`/examples/nestjs-mongoose-book-manager`):

```bash
$ yarn install --force
```

## Execution
Expand Down

0 comments on commit 4ee9b81

Please sign in to comment.