Skip to content
This repository has been archived by the owner on Apr 24, 2024. It is now read-only.

chartbrew/create-chartbrew-app

Repository files navigation

Create your Chartbrew app

A CLI tool for 📈 Chartbrew ☕

🚀 Get started

Run the command below and fill in the details as you are prompted. You will need to have MySQL running and prepare an empty database that Chartbrew can use.

npx create-chartbrew-app myApp

The CLI tool creates a chartbrew/.env file which you can configure at any time if you want to change the database, API & client host, etc. The file contains comments explaining what each environmental variable is for.

📦 Update an existing project

Navigate to the root of your Chartbrew project and run:

npx create-chartbrew-app update

This will create a local repository from your application if it's not created already, commit any changes, fetch the new update from upstream and merge with your project.

Note: This might result into multiple conflicts that you have to fix yourself. If you run into any issues you can always rollback to the previous commit that you or the tool made for you automatically.

📚 Read the docs

Check the documentation for extra information.