yogiliu / bamboo

A CMS optimized for conference hosting

Bamboo

A CMS optimized for conference hosting

Start with Docker

Create the .env file:

cp .env.example .env

And modify the environment variables in .env as needed, then start the containers:

docker-compose up

Development

Clone the repository:

git clone https://github.com/bamboo-cms/bamboo
cd bamboo

Make sure you have Python 3.12 and PDM installed, then install the dependencies:

pdm install

Run the backend application:

pdm serve

You can create tables in the database by running:

pdm drop-tables
pdm create-tables

Create a superuser:

pdm run flask create-admin

Run rq worker (Due to the lack of support for forking, it is recommended to use Docker on Windows platform):

pdm worker

Lint backend

pdm run pre-commit run --all-files

Tip

It's recommended to install the pre-commit hook to automatically lint your code before committing:

pdm run pre-commit install

Run the frontend development server (need to install pnpm):

cd frontend
pnpm install
pnpm dev

Lint frontend

pnpm run lint