BreachedTurbo is a monorepo boilerplate tooled using Turborepo and Bun, that prioritizes the developer's time and experience first.
Caution
It is currently NOT recommended to use this boilerplate for any production level projects.
Some of the features referred to within this README and the documentation provided are in an early stage or are not currently present.
If you choose to ignore this WARNING, then you do so at your own RISK!
Important
Whilst this repository is free to use, we do ask that the user's of the repo properly attribute it so others can easily find and use it!
BreachedTurbo is a monorepo boilerplate/starter tooled using Turborepo and Bun. It is designed to increase the speed at which developers can spin up new TurboRepo projects whilst still being easy to configure and customize. This boilerplate intends to provide a solid foundation for the developer without adding too much unnecessary code or dependencies that are difficult and time consuming to remove.
Where boilerplate code has been included, we have taken the time to make sure its easily configurable, organized well, and properly documented; most of the boilerplate code can either be easily ripped out or interacted with via scripts that can be called through the commandline. As BreachedTurbo utilizes the Bun runtime any scripts that are utilized, run much quicker than if they were to be ran on another JS runtime.
Whilst we try to keep this boilerplate easily configurable, we do still want it to be feature rich for those who the
batteries-included experience. To achieve this we have included a multiple config, tooling, and utility packages with
example apps.
- Powered by TurboRepo
- TypeScript for Type Safety and Checking
.
├── scripts # Stores all shared script files and utility scripts that are needed by the monorepo
│
├── tooling # Holds all repository tools and tooling packages for the monorepo
│
├── package.json # Project dependencies and scripts
├── turbo.json # Turbo configuration file
├── LICENSE.txt # License file
└── README.md # Readme fileTo install this boilerplate follow these steps:
Whilst it is not required to fork the repository, it is advised as this allows for easy remote repository creation.
To fork this repository press the the fork button at the top of the page,
Temporary Alt for Fork Button Picture
To get this repository onto your machine and into a local repository you need to clone the repository. Whilst it is not required, it is best to clone with a depth of 1 so only the last commit is cloned (shallow clone), and it should be cloned with a defined destination directory.
This can be done from the terminal (or git-bash) by using the following command,
git clone --depth=1 https://github.com/skyeBreach/breached-turbo.git [project_path]Or if you are using SSH to clone the repo,
git clone --depth=1 git@github.com:skyeBreach/breached-turbo.git [project_path]Where [project_path] can be optionally added to specify the relative path to clone the boilerplate.
Next you need to change directory to the newly cloned repository,
cd [project_path]Where [project_path] is either the path specified in Step 1, or if one was not
specified then it will be breached-turbo as it is the default project name.
Next you need to install the dependencies for all packages in the monorepo, this can be done by running the following command in the root (top-level) folder for the monorepo.
bun installRunning this command will also create or update the bun.lockb file which locks this repository to the
Bun runtime, which is necessary for BreachedTurbo.
bun turbo build© 2024, Skye Benson. All Rights Reserved.
See LICENSE for more information on the license that this repository uses.
