Skip to content

Commit 5535967

Browse files
committed
doc(samples) update samples
1 parent 35c79bd commit 5535967

21 files changed

Lines changed: 42994 additions & 7 deletions

File tree

sample/03-microservices/package-lock.json

Lines changed: 1457 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sample/05-sql-typeorm/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
### SQL TypeORM sample
2+
3+
### Installation
4+
5+
6+
`npm install`
7+
8+
### Running
9+
10+
This example requires docker or a local MySQL installation. If using a local MySQL database, see `app.module.ts` for credentials, and make sure there are matching credentials in the database and the source code.
11+
12+
#### Docker
13+
14+
There is a `docker-compose.yml` file for starting Docker.
15+
16+
`docker-compose up`
17+
18+
After running the sample, you can stop the Docker container with
19+
20+
`docker-compose down`
21+
22+
### Run the sample
23+
24+
Then, run Nest as usual:
25+
26+
`npm run start`
27+

sample/06-mongoose/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
### Mongoose sample
2+
3+
### Installation
4+
5+
6+
`npm install`
7+
8+
### Running
9+
10+
This example requires docker or a local mongodb installation. If using a local mongodb, see `app.module.ts` for connection options, and make sure there are matching options for the mongodb installation and the source code.
11+
12+
#### Docker
13+
14+
There is a `docker-compose.yml` file for starting Docker.
15+
16+
`docker-compose up`
17+
18+
After running the sample, you can stop the Docker container with
19+
20+
`docker-compose down`
21+
22+
### Run the sample
23+
24+
Then, run Nest as usual:
25+
26+
`npm run start`
27+

0 commit comments

Comments
 (0)