Build commands

API Reference

Tutorial Docs Community Website

Search…

Introduction

Build commands

These commands will allow you to generate the code that can be used to run or analyze a Frontity project
​build​
The build process
When you do npx frontity build you generate a build folder with several files.
You'll get something similar to this:
1
├── build
2
│   ├── analyze
3
│   │   ├── module-development.html
4
│   │   └── server-development.html
5
│   ├── bundling
6
│   │   ├── chunks.module.json
7
│   │   └── entry-points
8
│   │       ├── server.ts
9
│   │       └── my-frontity-project
10
│   │           └── client.ts
11
│   ├── server.js
12
│   └── static
13
           ...
14
│       ├── xxxxx1.module.js
15
│       ├── xxxxx2.module.js
Copied!
The most important file for deployments in any hosting is server.js, which is actually a middleware that can be inserted in a custom web server.
How to execute a Frontity project in production after the build
npx frontity serve
You can directly execute this server.js by using the command npx frontity serve.
So, easy way of executing a Frontity project in any Node.js server:
Launch remotely npx frontity build to generate the build folder.
Launch remotely npx frontity serve to launch a web server that makes use of the server.js generated in the previous step.
Using server.js as a middleware
You can also use this generated server.js as part of a custom server like it's mentioned here.
1
// lambda.js
2
const awsServerlessExpress = require("aws-serverless-express");
3
const app = require("./build/server.js").default;
4
const server = awsServerlessExpress.createServer(app);
5
​
6
exports.handler = (event, context) => {
7
  awsServerlessExpress.proxy(server, event, context);
8
};
Copied!
The bundle analyzer
Frontity generates some reports automatically by using Webpack Bundle Analyzer.
When doing npx frontity build you get a build folder in the root of your project.
1
├── build
2
│   ├── analyze
3
│   │   ├── module-development.html
4
│   │   └── server-development.html
5
│   ├── bundling
6
│   │   ├── chunks.module.json
7
│   │   └── entry-points
8
│   │       ├── my-frontity-project
9
│   │       │   └── client.ts
10
│   │       └── server.ts
11
│   ├── server.js
12
│   └── static
13
│       ├── my-frontity-project.module.js
14
│       └── list.module.js
Copied!
Inside that build folder there is a .html file generated at analyze/module-development.html. This file is a visual report in the form of a tree generated by Webpack Bundle Analyzer.
This report shows you the modules included on each bundle and the size of each one, so that you can analyze them and maybe decide using other modules (or not including a specific module at all) to reduce the size of the final bundle.

serve

build

Last modified 4mo ago

Copy link

Contents

The build process

How to execute a Frontity project in production after the build

The bundle analyzer

The build process

How to execute a Frontity project in production after the build

`npx frontity serve`

Using `server.js` as a middleware

The bundle analyzer