zixyos / minimouli

Get feedback on your projects without waiting for nao

Minimouli

Get feedback on your projects without waiting for nao

Table of Contents

• Installation
• Usage
• Contributing
• Frequently Asked Questions
• License

⚡️ Installation

Install with npm:

npm i -g minimouli

Or with Yarn:

yarn global add minimouli

🚀 Usage

Once installed, just run minimouli run in your project directory to start the automated tests. No configuration is required!

Pro-tip: run minimouli login first to see your results on a web page.

minimouli login
minimouli run

Make sure you have installed Node.js at least at version 14.17

Windows is currently not supported, but you can use WSL or Docker.

❤️ Contributing

The entire Minimouli project is open source. Feel free to check and contribute on GitHub by opening issues or pull requests.

The Minimouli project just started, there is still a lot to do!

🤷 Frequently Asked Questions

What is the minimum Node.js supported version ?

Minimouli supports Node.js from version 14.17 at least. You can see your current version of Node.js by running node -v.

We strongly encouraged you to use the latest version of Node.js for security and performance issues. You can update your Node.js version by using the nvm tool, you can learn more here.

I found a bug, what can I do ?

You can report the bug by opening a GitHub issue, in English or in French.

If the problem is related to the Minimouli project, please open an issue on this repository, otherwise, if the problem is related to a specific moulinette, please open an issue on the associated GitHub project.

If you feel strong enough, you can clone the project, fix the bug, and propose the correction by opening a pull request.

Is Minimouli free ?

Yes, minimouli will be free for everyone and forever.

📖 License

The Minimouli project is released under the MIT License.