MookMe

A simple and easy-to-use, yet powerful and language agnostic git hook for monorepos.

• see the documentation
• see the beta documentation

Notice: Mookme is deprecated

As of December 23rd 2024, Mookme has been officially discontinued in favor of Gookme, a Golang CLI with a binary executable offering the same functionality. Mookme will no longer receive updates or support. Please refer to the migration guide for more information.

The domain name mookme.org and the documentation website hosted on this domain will keep working until March 1st 2024.

After this date, the website will cease to exist and the repository as well as the npm package will be archived.

What you will find on this repository

• Description of the repository structure
• The entire source code associated with the Mookme project, including source code of CLI and the documentation page
• A roadmap of the project in a Github project [WIP]
• A list of opened issues and merge requests
• Development guidelines and contribution guide [WIP]

What you will not find on this page

• User documentation. See the project's website

Repository structure

The Mookme project is architectured around this monorepo. Every packages are stored under the packages folder. These include:

• /packages/mookme: The NodeJs project for the CLI of Mookme
• /packages/docs: A vuepress website holding the code of the user's documentation

You are new and willing to contribute ?

There are a few small issues and improvements that you can look into, that are designed and explained for first contributors.

Release channels

Mookme is released under a main channel and a beta channel. These both correspond to the beta and main branches of this repository.

Releases are manual for the beta channel, automated on the main channel.