An open API service indexing awesome lists of open source software.

https://github.com/nsttt/ncodes

A Discord bot for providing info and links to nHentai doujins.
https://github.com/nsttt/ncodes

api bot discord discordjs nhentai

Last synced: about 2 months ago
JSON representation

A Discord bot for providing info and links to nHentai doujins.

Awesome Lists containing this project

README

          

nCodes

# nCodes bot

> A Discord bot for displaying info about nHentai books.

[![Contributions](https://img.shields.io/badge/contributions-welcome-blue?style=flat-square)](https://github.com/nsttt/nCodes/compare/) [![Issues](https://img.shields.io/github/issues/nsttt/nCodes?style=flat-square)](https://github.com/Nsttt/nCodes/issues) [![License](https://img.shields.io/github/license/nsttt/nCodes?style=flat-square)](https://github.com/Nsttt/nCodes/blob/master/LICENSE.txt)

## Table of Contents

- [nCodes bot](#ncodes-bot)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Contribute](#contribute)
- [Step 1](#step-1)
- [Step 2](#step-2)
- [Step 3](#step-3)
- [Support](#support)
- [License](#license)

---

## Installation

To install run the following commands in the root folder.

```shell
yarn install
```

In order for the app to work, you would have to do a few more things.

First, create a new app in the discord developer portal.
After you have made your app, you will have to head to the **Bot** tab, and there you will have your **token**.
Keep it safe, anyone with that can mess with your bot.

In order to run your own instance of the bot, you will have to create a _.env_ file in the root folder. It must have the following structure.

```json
PREFIX="!n"
TOKEN="YourTokenHere"
```

You can change the prefix if you feel like it.

To serve a development build use the following command.

```shell
yarn dev
```

---

## Contribute

You can contribute to the development or improvement of this app and it will be much appreciated if you do !

### Step 1

- Fork this repo!

OR

- Clone this repo to your local machine using `git clone https://github.com/nsttt/nCodes.git`

### Step 2

- **HACK AWAY!** 🔨🔨🔨

### Step 3

- Create a new pull request using `https://github.com/nsttt/nCodes/compare/`

---

## Support

Reach out to me at one of the following places!

- Website at `nstlopez.com`
- Twitter at `@nstlopez`

---

## License

[![License](https://img.shields.io/github/license/nsttt/nCodes?style=flat-square)](https://github.com/Nsttt/nCodes/blob/master/LICENSE.txt)

- **[MIT license](http://opensource.org/licenses/mit)**
- Copyright 2020 © Néstor.