Guides
Create a project
libmodulor can be used in a brownfield project but we recommend starting a greenfield project to enjoy the full expressiveness and convention system.
With npx
npx libmodulor CreateProject --projectName my-super-projectBy default, it will create a folder named my-super-project in the current working directory and install the dependencies using pnpm.
If you want to change the defaults (initial commit, pkg manager, etc.), run the --help command.
npx libmodulor --help | grep CreateProject -C 10Execution should take a few seconds and give the following output.
Need to install the following packages:
libmodulor@latest
Ok to proceed? (y) y
2025-02-28T15:32:09.446Z [info] Creating root dir : my-super-project
2025-02-28T15:32:09.447Z [info] Initializing git repository
2025-02-28T15:32:09.495Z [info] Creating config files
2025-02-28T15:32:09.496Z [info] Creating apps and products directories
2025-02-28T15:32:09.496Z [info] Installing dependencies
2025-02-28T15:32:16.339Z [info] Committing
2025-02-28T15:32:16.483Z [info] Testing dev command : pnpm run lint
2025-02-28T15:32:17.134Z [info] Testing dev command : pnpm run test
2025-02-28T15:32:18.342Z [info] Done ! Project ready ! ✅ 🚀The generated directory has the following structure :
📁 src
📁 apps # the apps of the project (empty for now)
📁 products # the products of the project (empty for now)
📄 .gitignore # includes the files/dirs patterns to exclude from version control
📄 biome.json # config for the linter (feel free to change it if you don't like the defaults and run pnpm lint again)
📄 package.json # main config file containing info, scripts and dependencies
📄 README.md # main documentation file (feel free to enhance it with explanations about the purpose of your project)
📄 tsconfig.json # config file for TypeScript (pretty strict by default)
📄 vitest.config.ts # config file for Vitest, the test runnerOptionally, you can create a remote repository (e.g. on GitHub) and push it.
Manually
If you don't like the magic behind npx, or if you want to add libmodulor to an existing project, you can install it manually.
Check the required dependencies in package.json.