clickandmeow

A meow-mazing wrapper for Clic&Miam.

https://github.com/literateink/clickandmeow.js

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.7%) to scientific vocabulary

Keywords

clicetmiam scrapper wrapper
Last synced: 6 months ago · JSON representation ·

Repository

A meow-mazing wrapper for Clic&Miam.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 5
Topics
clicetmiam scrapper wrapper
Created about 1 year ago · Last pushed 11 months ago
Metadata Files
Readme Funding License Citation

README.md

ClickAndMeow: A meow-mazing wrapper for Clic&Miam.

Checks NPM Downloads Discord

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.

```bash

pnpm

pnpm add clickandmeow

Yarn

yarn add clickandmeow

npm

npm add clickandmeow

Bun

bun add clickandmeow ```

Quick Start

```typescript 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.

Owner

  • Name: LiterateInk
  • Login: LiterateInk
  • Kind: organization
  • Email: contact@literate.ink
  • Location: France

A unified school workspace for literally everyone.

Citation (CITATION.cff)

cff-version: 1.2.0
title: ClickAndMeow
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - name: LiterateInk
    website: "https://literate.ink"
    email: contact@literate.ink
  - name: Skythrew
    email: mael.guerin@murena.io
repository-code: "https://github.com/LiterateInk/ClickAndMeow.JS"
url: "https://clickandmeow.docs.literate.ink/"
repository-artifact: "https://www.npmjs.com/package/clickandmeow"
abstract: >-
  A meow-mazing wrapper for Clic&Miam.
keywords:
  - clicetmiam
  - wrapper
  - scrapper
license: GPL-3.0-or-later

GitHub Events

Total
Last Year

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 32
  • Total Committers: 2
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.5
Past Year
  • Commits: 32
  • Committers: 2
  • Avg Commits per committer: 16.0
  • Development Distribution Score (DDS): 0.5
Top Committers
Name Email Commits
Mikkel ALMONTE--RINGAUD c****t@v****m 16
Maël GUERIN m****n@m****o 16
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 3 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 2
npmjs.org: clickandmeow

A meow-mazing wrapper for Clic&Miam.

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 3 Last month
Rankings
Dependent repos count: 25.2%
Average: 30.9%
Dependent packages count: 36.5%
Maintainers (2)
Last synced: 6 months ago