diff --git a/examples/nestjs-mongoose-book-manager/LICENSE b/examples/nestjs-mongoose-book-manager/LICENSE new file mode 100644 index 0000000..0538f01 --- /dev/null +++ b/examples/nestjs-mongoose-book-manager/LICENSE @@ -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. diff --git a/examples/nestjs-mongoose-book-manager/README.md b/examples/nestjs-mongoose-book-manager/README.md index c94af32..13f08c3 100644 --- a/examples/nestjs-mongoose-book-manager/README.md +++ b/examples/nestjs-mongoose-book-manager/README.md @@ -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