callmekory/nezuko repository overview

⁠

⁠Nezuko

Smart Home, Automation, and all purpose server management bot.

Report Bug⁠ · Request Feature⁠

⁠About The Project

I made Nezuko to automate and simplify my life. From controlling lights and smart plugs to media management and Docker control. If its not here it'll be here. Feel free to PR and ask for new features!

⁠Commands

Nezuko has a built in web UI / API server for remotely running commands. For API enabled commands you can add them as buttons on the Web UI send HTTP POST requests from your favorite applications. I personally use HTTP Request Shortcuts on my Galaxy. It has a nice UI with support for custom icons, etc.

⁠Prerequisites

To get a local copy up and running follow these simple steps.

1. Clone Nezuko

git clone https://github.com/callmekory/nezuko.git

1. Install Yarn

Ubuntu / Debain

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -

echo deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

sudo apt install yarn

Arch Linux

sudo pacman -S yarn

1. Install packages

> yarn install

⁠Setup

1. Setup Bot Token and Prefix

1. Setup Command Configs

If you would like to run Nezuko as a Docker container you'll need to build the image yourself.

1. Clone the repo to a folder of choice
2. CD into the folder and inside the folder data rename config.js.sample to config.js and enter your discord user ID and your bot token.
3. Navigate back into the main directory and run docker build -t nezuko .
4. After the build is finished you can run Nezuko with docker run -p 570:5700 --name nezuko nezuko. If you'd rather use Docker-Compose as I do then you can use the following sample config. Simply save it as docker-compose.yml and run docker-compose up -d to start her up. The webUI will be available at http://BOTIP:5700.

version: '3'
services:
  nezukoBot:
    image: callmekory/nezuko
    container_name: nezuko
    volumes:
      - ./config:/app/build/config
    ports:
      - 5700:5700
    network_mode: bridge
    restart: unless-stopped

⁠Roadmap

See the open issues⁠ for a list of proposed features (and known issues).

⁠Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

⁠License

Distributed under the GPL3 License. See LICENSE for more information.

⁠Contact

You can shoot me a PM on Discord if you have any question. My tag is Sublime#4233

⁠Acknowledgements

• Mellow - Ombi movies/series code⁠
• nwithan8⁠
• codetheweb/tuyapi⁠