This project does not aim to replace the official NestJS Awesome List but rather to provide a nicer experience when browsing the content.
To run this application on your machine, first clone the repository and install the required dependencies:
git clone https://github.com/777Vasya77/awesome-nestjs.git
cd awesome-nestjs
npm install
Run the dev
script to compile the content and spawn a local server to serve the compiled code. While this script is running, any changes made to the markdown files will automatically be updated on the locally served pages. Go to http://localhost:5173 on your web browser to view the site.
npm run dev
To prepare the application for deployment, first run npm run build
to compile the application in production mode. This will generate a directory in content/.vitepress
called dist
.
npm run build
# You can use `npm run preview` to inspect the output
npm run preview --port 4173
Script | Description |
---|---|
dev |
Compiles content and serves bundled code |
build |
Compiles content and other static assets for deployment |
preview |
Locally preview the production build |
update-content |
Run content updater |
Please refer to the Contributing Guide.
This is free and unencumbered software released into the public domain.
For more information, please refer to https://unlicense.org