This library is not affiliated with ↗ Clic&Miam in any way.

What is "Clic&Miam" ?

↗ Clic&Miam is a management software used by some restaurants in France. It allows restaurants to publish their menus online to be seen by customers.

Installation

Use your favorite package manager to install this library from the npm registry.

# pnpm
pnpm add clickandmeow

# Yarn
yarn add clickandmeow

# npm
npm add clickandmeow

# Bun
bun add clickandmeow

Quick Start

import * as ClickAndMeow from "clickandmeow";

// You first have to authenticate with Clic&Miam to get a session.
// Once you have a session, you can use it to make requests to Clic&Miam.
const session = await ClickAndMeow.login("username", "password");

// Let's grab the list of establishments for the current user.
const establishments = await ClickAndMeow.getEstablishments(session);
console.log(establishments);

You can find guides at ↗ clickandmeow.docs.literate.ink and if it's not enough you can also take a look at the ↗ examples directory on the GitHub repository for inspiration.

If none of those are helpful, you can always ↗ open an issue to ask for help or join the ↗ LiterateInk Discord server.

License

This project is licensed under the GPL-3.0 License - see the LICENSE.md file for details.