Elvis .N.

monorepo
open source

open source

My journey Converting a Sveltekit Repo into a Monorepo using Turbo

6 months ago . 5 min read

Share:

article

Greetings, readers and fellow developers! I recently had the opportunity to undertake a significant task: consolidating multiple projects from distinct repositories into a unified mono-repo for an open-source initiative named ClassroomIO. This article outlines the steps I followed and the hurdles encountered throughout the migration. To begin, let's briefly delve into ClassroomIO.

ClassroomIO is an innovative platform tailored for bootcamps, individual educators, and training enterprises, designed to integrate teaching and learning while boosting productivity tenfold. The platform enables the seamless management of numerous classes and cohorts through a single, user-friendly interface. Emphasizing a mobile-first approach, ClassroomIO ensures that students can access educational materials from any device, anywhere.

Initially, ClassroomIO was spread across three separate project repositories:

Before I got assigned the task, all projects had contributors and commit attached to them, so keeping the commit history was important.

Creating the workspace

blog image

First, I had to set up a workspace inside classroomio repository using pnpm. The folder structure follows TurboRepo's walkthrough, so I did the following:

blog image

This approach kept the commit history in this repository intact.

Adding other projects to the mono-repo project was as easy as copying everything (except for the node_module folder and package-lock.json) into their respective folders.

đź’ˇI had to edit the `name` field in each project's package.json to avoid conflicts when adding new NPM packages to specific projects

Next, I went through the `package.json` files inside each project, and modified their `devDependencies` and `dependencies` fields to include packages from the workspaces, and their script commands before I installed all packages using `pnpm install`.

Fixing build errors

Building all 3 projects and testing them in dev mode came with a few issues.

blog image

blog image

blog image

Conclusion

In conclusion, my journey to transform multiple repositories into a single monorepo for ClassroomIO has been a challenging yet rewarding experience. Through this process, we've successfully merged three distinct projects into one cohesive repository, preserving the valuable commit history. This endeavor not only streamlined our development process but also enhanced the overall efficiency and collaboration within our team.

As we continue to develop and refine ClassroomIO, I invite you to join us in this exciting journey. Your support and contributions are invaluable to the growth and success of this open-source project. If you find ClassroomIO intriguing or useful, please consider starring the project on GitHub to show your support. Additionally, for real-time discussions, insights, and a chance to collaborate with a community of like-minded individuals, join our Discord channel. Your feedback, suggestions, and contributions will help shape the future of ClassroomIO, making it an even more powerful tool for educators and learners alike. Together, let's revolutionize the world of online education!

More Articles

profile

Decomposing Monoliths: A Journey into Converting an Open Source Project to a Monorepo

Bringing all 3 Classroomio projects into one repository. Challenges Faced, Solutions Found, and the Transformational Impact on Developer Workflow

monorepo
portfolio v1