Quick start

This quick start is intented to get you up and running with Flame as quickly as possible.

Install the Flame CLI

bash <(curl -sL https://tryflame.com/install.sh)

Create a new app

flame new app https://github.com/tryflame/flame-starter-express-react-typescript

This will create a new directory named app with a Typescript Express server and a Typescript React app.

If you’re looking for a different setup, check out our Starter library.

Change directories into newly created folder

cd app

Start development server

flame run

Flame will start a development server accessible by default at localhost:8000.

Deploy to production

flame deploy

Flame will perform an optimized production build for your site, bundle it into a Docker image, push that image to a container registry, and deploy it to a Kubernetes cluster.

In order to deploy successfully, you’ll need to update your container registry and your Kubernetes cluster in server/deployment.yaml and server/BUILD.

Access documentation for CLI commands

To see detailed documentation for the CLI commands, run flame help in the terminal.

For specific commands, run flame help COMMAND_NAME e.g. flame help run.