Skip to content

Latest commit

 

History

History
87 lines (67 loc) · 3.77 KB

README.md

File metadata and controls

87 lines (67 loc) · 3.77 KB
Raw

Before read/install/clone this project
Shuvi is still in development and unstable. Specification or structures in sources can change and/or may vary at any time.

Shuvi

Visual Studio Code logo Visual Studio Code Remote Development and GitHub Codespaces
Open your code in the cloud, in a local container, on a remote machine, or in WSL and take advantage of VS Code's full feature set.

License

Shuvi is a discord bot using Node.js with TypeScript. The code is built on ECMAScript 2020 and can be transpiled to JavaScript with TypeScript 4.0. Shuvi not only based on Discord.js v12 library, but it also used common modules.

Official Shuvi bot is not publicly available and has no plans to support it. You can touch the bot in Official Discord Server and/or Izuna Online.

Related Repositories

Development Features

  • 100% promise-based
  • Supports type infers
  • Written with TypeScript based on ECMAScript 2020

Key Features

  • Available to customize join/leave action
  • Add custom commands per guild so that perform the desired action

To-do Development Features

  • Support for more sophisticated code conventions

Quick Start

In order to start nor build the project, ensure that you have Git and Node.js installed.
If you're using Windows, you need extra steps in addition.
NOTE: If you're looking for development, click here.

Step 1. Clone the code

$ git clone git+git+https://github.com/Sayakie/Shuvi.git --recursive
$ cd Shuvi

Step 2. Run built-out code.

$ npm run start

Development Installation

Requirements

  • Node.js v10 or higher
    • (Recommended Version: Node.js v12)
  • NPM (Automatically installed with Node.js)

Tests

To run the test suite, first install the dependencies, the run below script:

$ npm install
$ npm test

Community

How To Contribute

Contributions are always welcome, either reporting issues/bugs or forking the repository and then issuing pull requests when you have completed some additional coding that you feel will be beneficial to the main project. If you are interested in contributing in a more dedicated capacity, then please check out Contributing.md.

  • Code of Conduct
  • Issues
    • Asking for general help
    • Security Policies and Procedures
  • Pull request
    • Setting up your local environment
    • Making changes
    • How to add commands
    • How to add events (includes custom event)

License

The top-class is licensed under the Affero GPLv3 License:

Copyright (c) 2020 Sayakie

Shuvi is free software. you can redistribute it and/or modify it under the terms of: the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License. Shuvi is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY of FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. You should have received a copy of both licenses along with Shuvi.