hernikplays / kaiwa Goto Github PK

Discord robot pro studenty jazyků (primárně japonštiny)

Report Bug . Request Feature

• O Projektu
• Začínáme
  • Než začneme
  • Instalace
• Přispíváme
• Licence
• Poděkování

Pro všechny studenty, jazykové servery a fanoušky jazyků přináším robota, který umožňuje prohlížet slovníky, hrát jazykové hry a další fičurky:tm:

Zde najdete návod jak si hostovat vlastní verzi tohoto bota na vašem účtu. Pokud pouze chcete bota používat, pozvěte skrze tento odkaz.

Než začnete, ujistěte se, že máte vytvořený bot účet ve vývojářském portálu. Poté si zkopírujte jeho token.

Nainstalujte si NodeJS a NPM. (LTS by mělo stačit)

1. Stáhněte si repozitář Buď skrz tlačítko nahoře nebo v konzoli git clone https://github.com/hernikplays/kaiwa
2. Nainstalujte závislosti Skrz npm i
3. Vložte svůj token Vytvořte v kořenovém adresáři soubor .env do kterého zapíšete TOKEN=VASTOKEN, kde VASTOKEN je samozřejmě váš token.
4. Spusťte Skrz příkaz npm start

Přispívání je vítáno!

• Hlašte chyby či žádejte o funkce v Issues
• Přidávejte sami funkce do kódu (viz Vytváříme Pull Request)

Více viz CONTRIBUTING

Vydáno pod licencí GNU General Public License Version 3. Pro více informací viz soubor LICENSE.

• typescript
• unofficial-jisho-api Copyright (c) 2017 mistval, použito pod licencí MIT
• sdapi Copyright (c) 2019, Symeon Huang, použito pod licencí BSD 3-Clause
• axios Copyright (c) 2014-present Matt Zabriskie & Collaborators pod licencí MIT
• dotenv Copyright (c) 2015, Scott Motte pod licencí BSD 2-Clause License