Cloud Quickstart

note

Start here if you want to customize FireCMS Cloud. You can run a FireCMS project without writing a single line of code from FireCMS Cloud. This guide is for developers who want to add custom code to their FireCMS project.

In order to add custom code to your FireCMS project, you need:

• A Firebase project
• A FireCMS project

You can create both projects from FireCMS Cloud.

Go to FireCMS Cloud

Once you have both projects created you can initialize your codebase by running:

npx create-firecms-app

or

yarn create firecms-app

Make sure to select the option FireCMS Cloud, and follow the instructions in the CLI.

This will create a new folder with all the code you need to get started. In the code you will be able to add custom collections, custom pages, custom fields, custom actions, custom properties, etc.

Running your project

To run your project locally, you can run the following command, like any other Vite project:

npm run dev

or

yarn dev

This will execute a version of your project that uses FireCMS backend to store config data but runs locally.

You should be able to see your FireCMS instance in your browser, including all the configuration you have already created in the Cloud version... Awesome!

If you want to deploy to FireCMS Cloud your module must export a FireCMSAppConfig object. You can find more information about this object in the App config section reference.

important

Vite uses the default url http://127.0.0.1:5173 for the development server in versions of node < 18.0.0. If you are using a version of node < 18.0.0, you will need to add this url to the authorized domains in the Firebase console. Firebase Auth will require to add this url to the authorized domains in the Firebase console. Alternatively, you can use the url http://localhost:5173.

How does code upload work?

We use module federation to upload your code to FireCMS Cloud. This means that you can upload your code to FireCMS Cloud without having to worry about the infrastructure.

When you run the command yarn deploy or npm run deploy, your code will be uploaded to FireCMS Cloud and will be available in the FireCMS Cloud instance.

Only your code will be uploaded, and it will be integrated into the core FireCMS Cloud. This means that you can use the same authentication system, the same collections, the same pages, etc.

This approach allows you to have a CMS that is fully customizable while still benefiting of the continuous improvements and updates that we provide in FireCMS Cloud.