@nestjs/serve-static

v4.0.2

Nest - modern, fast, powerful node.js web framework (@serve-static) For more information about how to use this package see README

Latest version published 9 months ago

License: MIT

NPM

GitHub

Package Health Score

73 / 100

security
Security review needed
popularity
Popular
maintenance
Sustainable
community
Sustainable

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
4.0.2	\|	03/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.1	\|	02/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.2.2	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.2	\|	11/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (297,596)

GitHub Stars: 465
Forks: 62
Contributors: 20

Direct Usage Popularity

The npm package @nestjs/serve-static receives a total of 297,596 downloads a week. As such, we scored @nestjs/serve-static popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @nestjs/serve-static, we found that it has been starred 465 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the @nestjs/serve-static repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @nestjs/serve-static is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 10
Open PR: 7
Last Release: 9 months ago
Last Commit: 11 days ago

Further analysis of the maintenance status of @nestjs/serve-static based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @nestjs/serve-static demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 1 Direct
Versions: 17
Install Size: 30.2 kB
Dist-tags: 2
# of Files: 32
Maintainers: 2
TS Typings: No

@nestjs/serve-static has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use @nestjs/serve-static?

To help you get started, we've collected the most common ways that @nestjs/serve-static is being used within popular public projects.

CatsMiaow / node-nestjs-structure / src / app.module.ts View on Github

}),
    // Database
    // https://docs.nestjs.com/techniques/database
    TypeOrmModule.forRootAsync({
      useFactory: async (config: ConfigService) => ({
        entities: [`${__dirname}/entity/**/*.{js,ts}`],
        subscribers: [`${__dirname}/subscriber/**/*.{js,ts}`],
        migrations: [`${__dirname}/migration/**/*.{js,ts}`],
        ...config.get('db')
      }),
      inject: [ConfigService]
    }),
    // Static Folder
    // https://docs.nestjs.com/recipes/serve-static
    // https://docs.nestjs.com/techniques/mvc
    ServeStaticModule.forRoot({
      rootPath: `${__dirname}/../public`,
      renderPath: '/'
    }),
    // Module Router
    // https://github.com/nestjsx/nest-router
    RouterModule.forRoutes([{
      path: 'aws',
      module: AWSModule
    }, {
      path: 'test',
      module: SampleModule
    }]),
    // Service Modules
    CommonModule, // Global
    BaseModule,
    AWSModule,

View more ways to use @nestjs/serve-static

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

@nestjs/serve-static package for Nest, useful to serve static content like Single Page Applications (SPA). However, if you are building MVC application or want to serve assets files (images, docs), use the useStaticAssets() method (read more here) instead.

Installation

$ npm i --save @nestjs/serve-static

Example

See full example here.

Usage

Simply import ServeStaticModule in your Nest application.

import { Module } from '@nestjs/common';
import { join } from 'path';
import { ServeStaticModule } from '@nestjs/serve-static';

@Module({
  imports: [
    ServeStaticModule.forRoot({
      rootPath: join(__dirname, '..', 'client')
    })
  ]
})
export class ApplicationModule {}

API Spec

The forRoot() method takes an options object with a few useful properties.

Property	Type	Description
`rootPath`	string	Static files root directory. Default: `"client"`
`serveRoot`	string	Root path under which static app will be served. Default: `""`
`renderPath`	string / RegExp	Path to render static app (concatenated with the `serveRoot` value). Default: * (wildcard - all paths). Note: `RegExp` is not supported by the `@nestjs/platform-fastify`.
`exclude`	string[]	Paths to exclude when serving the static app. WARNING! Not supported by `fastify`. If you use `fastify`, you can exclude routes using regexp (set the `renderPath` to a regular expression) instead.
`serveStaticOptions`	Object	Serve static options (static files)

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

Author - Kamil Myśliwiec
Website - https://nestjs.com
Twitter - @nestframework

License

Nest is MIT licensed.

@nestjs/serve-static dependencies

path-to-regexp

FAQs

What is @nestjs/serve-static?

Nest - modern, fast, powerful node.js web framework (@serve-static). Visit Snyk Advisor to see a full health score report for @nestjs/serve-static, including popularity, security, maintenance & community analysis.

Is @nestjs/serve-static popular?

The npm package @nestjs/serve-static receives a total of 297,596 weekly downloads. As such, @nestjs/serve-static popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @nestjs/serve-static well maintained?

We found indications that @nestjs/serve-static maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @nestjs/serve-static safe to use?

While scanning the latest version of @nestjs/serve-static, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 22 December-2024, at 07:42 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

@nestjs/serve-static

Nest - modern, fast, powerful node.js web framework (@serve-static) For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (297,596)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Not sure how to use @nestjs/serve-static?

Description

Installation

Example

Usage

API Spec

Support

Stay in touch

License

@nestjs/serve-static dependencies

@nestjs/serve-static development dependencies

FAQs

What is @nestjs/serve-static?

Is @nestjs/serve-static popular?

Is @nestjs/serve-static well maintained?

Is @nestjs/serve-static safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (297,596)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use @nestjs/serve-static?

Description

Installation

Example

Usage

API Spec

Support

Stay in touch

License

@nestjs/serve-static dependencies

@nestjs/serve-static development dependencies

FAQs

What is @nestjs/serve-static?

Is @nestjs/serve-static popular?

Is @nestjs/serve-static well maintained?

Is @nestjs/serve-static safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues