To install Crema on the system, you need to develop a React Environment in the system

Crema doesn't have any special requirements to start the project. To run and develop Crema on the system, you need to have a React environment-ready system with the recommended version of Node.js. You can use yarn as well to start the project.

Node is a JavaScript run time built needed to run a React App. You need to install the recommended version of Node.js from the official website

Yarn is a project manager responsible for adding and installing all the dependencies required for running the Crema on the system. You can install the latest version of Yarn from the official website


Once you have followed the installation pre-requisite steps, You can follow the following steps to install and run the Crema:-

1. To run the Crema, Open the Crema folder in the editor of your choice. After following the folder, open the terminal and run the following command:-


this command will automatically install the required dependencies.

If you are using the Next.js version then you need to check this doc

2. Now, run the following command to run the project in the browser.

yarn start

This command will start the project in the browser in development mode i.e. the project will run on localhost://300X URL.

3. To add the project to the live server, you need to make the Build of the project. Run the following command to make the Build of the project.

yarn build

After successful completion of the build command, you will find the following instructions on the terminal:-

The project was built assuming it is hosted at the server root. You can control this with the homepage field in your package.json. For example, add this to build it for GitHub Pages:

"homepage" : "",

The build folder is to ready be deployed. You may serve it with a static server:

yarn global add serve
serve -s build

Find out more about deployment here

In case you want to deploy on another server please change accordingly.

Last updated