Serve static websites (SPA's) using Nest framework (node.js) 🥦
A progressive Node.js framework for building efficient and scalable server-side applications.
<!--@nestjs/serve-staticpackage 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.
$ npm i --save @nestjs/serve-static
See full example here.
Simply import
ServeStaticModulein 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 {}
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
serveRootvalue). Default: * (wildcard - all paths) | |
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
renderPathto a regular expression) instead. | |
serveStaticOptions| Object | Serve static options (static files) |
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.
Nest is MIT licensed.