diff --git a/README.md b/README.md index fe3baa7..a3138db 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,15 @@ Now, each of the sub-modules are available in the `modules/` directory, and the This difference is because the packages are all installed from their locations on the filesystem, for ease of development. +### Using forked repos +Extollo contributions should be done via pull-request on the Gitea server. To clone your user's copy of the Extollo repos instead of the official ones, use the `--git` argument: + +```shell +npm run setup --git=git@code.garrettmills.dev:youruser/extollo- +``` + +For example, instead of using `https://code.garrettmills.dev/extollo/lib` for the `modules/lib/` package, it will clone `git@code.garrettmills.dev:youruser/extollo-lib`. + ## Building Packages To re-build all of the modules, you can run the `pnpm build` command. To rebuild a particular package, use `pnpm build:`. diff --git a/package.json b/package.json index 1dba861..6c4ff5d 100644 --- a/package.json +++ b/package.json @@ -11,13 +11,13 @@ "clean:modules": "rm -rf modules/lib modules/di modules/orm modules/util modules/cli modules/i18n", "clean:extollo": "rm -rf extollo", "clone:all": "pnpm run clone:lib && pnpm run clone:di && pnpm run clone:util && pnpm run clone:orm && pnpm run clone:cli && pnpm run clone:i18n && pnpm run clone:extollo", - "clone:extollo": "git clone https://code.garrettmills.dev/extollo/extollo extollo", - "clone:lib": "git clone https://code.garrettmills.dev/extollo/lib modules/lib", - "clone:di": "git clone https://code.garrettmills.dev/extollo/di modules/di", - "clone:util": "git clone https://code.garrettmills.dev/extollo/util modules/util", - "clone:orm": "git clone https://code.garrettmills.dev/extollo/orm modules/orm", - "clone:cli": "git clone https://code.garrettmills.dev/extollo/cli modules/cli", - "clone:i18n": "git clone https://code.garrettmills.dev/extollo/i18n modules/i18n", + "clone:extollo": "git clone ${npm_config_git:-https://code.garrettmills.dev/extollo/}extollo extollo", + "clone:lib": "git clone ${npm_config_git:-https://code.garrettmills.dev/extollo/}lib modules/lib", + "clone:di": "git clone ${npm_config_git:-https://code.garrettmills.dev/extollo/}di modules/di", + "clone:util": "git clone ${npm_config_git:-https://code.garrettmills.dev/extollo/}util modules/util", + "clone:orm": "git clone ${npm_config_git:-https://code.garrettmills.dev/extollo/}orm modules/orm", + "clone:cli": "git clone ${npm_config_git:-https://code.garrettmills.dev/extollo/}cli modules/cli", + "clone:i18n": "git clone ${npm_config_git:-https://code.garrettmills.dev/extollo/}i18n modules/i18n", "install:all": "pnpm run install:util && pnpm run install:di && pnpm run install:lib && pnpm run install:cli && pnpm run install:orm && pnpm run install:i18n && pnpm run install:extollo", "install:extollo": "cd extollo && cp example.env .env && pnpm i --save @extollo/cli@file:../modules/cli @extollo/orm@file:../modules/orm @extollo/di@file:../modules/di @extollo/lib@file:../modules/lib @extollo/util@file:../modules/util @extollo/i18n@file:../modules/i18n", "install:lib": "cd modules/lib && pnpm i --save @extollo/di@file:../di @extollo/util@file:../util && pnpm run build && cd ../..",