https://github.com/kurisubrooks/midori

:wrench: advanced modular discord bot
https://github.com/kurisubrooks/midori

advanced bot discord discordjs framework midori modular

Last synced: 2 months ago
JSON representation

:wrench: advanced modular discord bot

• Host: GitHub
• URL: https://github.com/kurisubrooks/midori
• Owner: kurisubrooks
• License: other
• Created: 2016-06-15T11:24:35.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T00:46:56.000Z (almost 2 years ago)
• Last Synced: 2024-10-14T21:44:50.308Z (2 months ago)
• Topics: advanced, bot, discord, discordjs, framework, midori, modular
• Language: JavaScript
• Homepage:
• Size: 49.6 MB
• Stars: 41
• Watchers: 4
• Forks: 11
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![Midori](http://i.imgur.com/XY3TmDR.png)



    

        

    

    

        

    

    



    Brand spanking new Nano with 100% less shit code!

    


    Click here to add Midori to your server!



## Building

### Prerequisites

**macOS**

```bash

brew install pkg-config cairo pango libpng jpeg giflib

```

**Ubuntu**

```bash

sudo apt install libcairo2-dev libjpeg8-dev libpango1.0-dev libgif-dev build-essential g++

```

### Installation

```bash

git clone https://github.com/kurisubrooks/midori.git

cd midori

npm install

```

### Setup

Create a file called `keychain.json` in the main directory, with the following contents, filling in each line with the appropriate keys needed for each. (Make sure to remove the comments)

```js

{

  "self": "", // Discord Bot Token

  "darksky": "", // DarkSky Weather API Key

  "sherlock": "", // Sherlock API Key

  "google": {

    "cx": "", // Google Search API CX

    "search": "", // Google Search API Key

    "geocode": "" // Google Geolocation API Key

  }

}

```

### Run

You can start Midori by simply typing the following:

```bash

npm start

```

If you wish to run Midori under Production, you can start her with pm2 by using

```bash

pm2 start index.js --name "midori" -- --color

```

### Development

Thanks for taking interest in Midori!

I've included some build commands through the Gulp build tool, some of which you might find useful.

**Linting**  

Run this command to find errors in your syntax.  

(You'll need to do this if you plan on submitting any Pull Requests!)

```bash

npm run lint

```

**Run**  

Run this command to start Midori.  

You'll need to do this from the root directory

```bash

npm start

```