| title | Quickstart |
|---|---|
| description | Run Chartbrew locally for development. |
Use this guide for local development. For a production installation, start with Deployment overview.
Node.js 22.23.4 or later in the Node.js 22 series. Use the repository’s .nvmrc to select the project version.
NPM
MySQL or PostgreSQL, with a dedicated Chartbrew database. The repository includes Compose examples for MySQL 8.4 and PostgreSQL 16.
Redis (v6+)
The setup doesn't work in Windows PowerShell or cmd.exe. If you're using Windows, please use a bash command line like [Git Bash](https://git-scm.com/downloads) or [cygwin](https://www.cygwin.com/install.html)Chartbrew works with both MySQL and PostgreSQL. You can use any of the two, but you need to create a database first.
git clone https://github.com/chartbrew/chartbrew.git
cd chartbrew && npm run setupAll the environment variables that need to be set are found in the .env-template file in the root folder of the project. If you ran the setup above, you should already have a .env file there as well. If not, copy the template file and rename it .env.
Use the original variable names in every environment. Set your local database and Redis connection values. Keep the default local client and API URLs unless you use different ports.
See the full list of variables here
Generate a key and save it as CB_ENCRYPTION_KEY in .env:
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"Keep this key when you restart or update the application so that saved credentials remain readable.
Development startup does not apply database migrations. From the project root, run:
NODE_ENV=development npm --prefix server run db:migrateThe server dependency installation also installs Chromium for chart images. If it fails, correct the reported error and run npm --prefix server run install:playwright.
Open two terminals, one for front-end and the other for back-end.
# frontend
cd client/
npm run start
# backend
cd server/
npm run start-devChartbrew uses queues to update datasets automatically and it uses Redis to achieve this. In order for your datasets and charts to update automatically, you need to set up Redis first.
Find out how to set up Redis on various platforms here..
Open http://localhost:4018 and create your first account.
Backend
Frontend
Docs