typescript-monorepo-starter is a GitHub template designed to kickstart your next TypeScript 5 project, offering an opinionated, ready-to-use monorepo structure that takes care of all the tricky configuration for you.
The following packages are implemented and at your disposal:
Create your repositoryCreate your monorepo repository using this template.
Configure GitHub permissionsEnable GitHub actions to create and approve pull requests.
Go to Settings > Actions > General > Workflow permissions
Enable the following settings:
✅ Read and write permissions
✅ Allow GitHub Actions to create and approve pull requests
Save changes.
Configure GitHub actionsRun existing actions for the first time.
Go to Actions > typedoc-generator.yml
Click on the Run workflow button.
Repeat the process for all test- prefixed workflows.
After all workflows finish, navigate to Settings > Pages.
Select the gh-pages branch as the deployment source.
Save changes.
Configure GitHub ciConfigure branch protection rules to prevent direct pushes to the main branch, require pull requests for merging, and all status checks to pass before merging.
Set the branch name pattern to main.
Enable the following settings:
✅Require a pull request before merging
✅Require status checks to pass before merging
✅Require branches to be up to date before merging
Disable the setting:
❌ Require approvals
Select the following workflows as required for all pull requests:
test-app-node-express
test-app-vite-react
test-lib-commons
test-lib-api-client
Save changes.
Local installation
Clone to local machineClone previously created repository into your local machine.