Getting Started

Falcon Client is part of Falcon Platform and is included when using create-falcon-app.

Falcon Client Commands

From the client directory you can run the following commands (in your terminal).

Start

npm start

This will call the falcon-client executable to start up the client process with Node.js.

Options

  • --inspect=[host:port] - To debug the node server. This will start the node server and enable the inspector agent. The =[host:port] is optional and defaults to =127.0.0.1:9229. See the Node.js debugging guide for more information.
  • --inspect-brk=[host:port] - This is the same as --inspect, but will also break before user code starts. (to give a debugger time to attach before early code runs).

Useful Variants

  • start:dbg - An alias for --inspect
  • start:dbg-brk - An alias for --inspect-brk

Test

This run the test watcher (Jest) in an interactive mode. By default, runs tests related to files changed since the last commit.

npm test

Build

Builds the app for production, and outputs to the ./build folder.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

npm build:prod

Size

Runs an interactive zoomable treemap of output files to visualize their size. Report will be automatically open in default browser at http://localhost:8888.

npm size

Restart

If your application is running, and you need to manually restart your server, you do not need to completely kill and rebundle your application. Instead you can just type rs and press enter in terminal.

rs

Ask the community. #help

If you can't find what you're looking for, the answer might be on our community slack channel. Our team keep a close eye on this and will usually get back to you within a few hours, if not straight away. If you haven't created an account yet please sign up here slack.deity.io.