Onboarding Codelab starterkit

Howdy! Glad to see you here partner :)

What is this?

This is a template for creating Google Codelabs. It's a product created by Google for creating interactive tutorials for developers.

How does it work?

It works using markdown files. When following a specific standard, Claat (Code labs as a thing) is a tool that converts markdown files into a web page. It's a tool created by Google.

You can install the claat tool locally using Go. But then you have to install Go and set up your environment. It's a bit of a hassle. That's why I included the claat tool in this repository.

How do I get started?

Clone this repository
Install Node if you don't have it already
Run pnpm install to install the dependencies
Run pnpm docs:serve to start the local server
Open http://127.0.0.1:8080 in your browser to see the rendered codelab
Profit

How do I edit the codelab?

Run pnpm docs:serve to start the local server
Edit the index.md file
Refresh your browser after making changes

How do I publish the codelab?

You can use any hosting platform. I recommend netlify.com. It's free and easy to use.

Example project (Frontend)

If you want to see an example project, you can check out the frontend onboarding project.

Github