create-filo-cms
v0.3.2
Published
Scaffold a self-hosted Filo CMS project with one command: npm create filo-cms@latest
Downloads
34
Readme
create-filo-cms
Scaffold a self-hosted Filo CMS project with one command — the way create-strapi-app works, but for Filo.
npm create filo-cms@latest my-app
# or: pnpm create filo-cms my-app / yarn create filo-cms my-app / npx create-filo-cms my-appThe wizard asks about your database (an existing DATABASE_URL or a generated docker-compose.yml with PostgreSQL 17) and your admin e-mail, then:
- generates a minimal Nuxt project that inherits the whole CMS from the
@filo-cms/cmslayer, - writes
.envwith cryptographically random secrets (NUXT_SESSION_PASSWORD,NUXT_ENCRYPTION_KEY) and admin credentials, - includes an example custom API endpoint and middleware to start from,
- installs dependencies with your package manager (npm / pnpm / yarn / bun — auto-detected).
Then:
cd my-app
docker compose up -d # if you chose the generated Postgres
npm run devOn first boot the CMS migrates and seeds the database automatically and creates your admin account. Log in at http://localhost:3000/admin.
Non-interactive mode (CI, scripts)
npx create-filo-cms my-app \
--db docker # or: --database-url postgres://user:pass@host:5432/db
--email [email protected] \
--no-install # or --installWhat's generated
my-app/
├── nuxt.config.ts # extends: ["@filo-cms/cms"] — the whole CMS comes from the layer
├── server/
│ ├── api/hello.get.ts # example custom endpoint → GET /api/hello
│ └── middleware/request-logger.ts
├── .env # secrets (never commit)
├── .env.example
├── docker-compose.yml # optional PostgreSQL 17
└── README.md # how to run, extend and consume the APIUpdating the CMS later = bumping the @filo-cms/cms version in package.json.
Requirements
- Node.js >= 22
- A PostgreSQL database (or Docker for the generated one)
Links
- Filo CMS repository & documentation
- License: MIT
