Skip to content

Nekitori17/Shakiri-Ayui

Repository files navigation

Shakiri Ayui 🤖

Technologies Getting Started

A Source Code Of My Small Discord Bot

💻 Technologies

  • Nodejs
  • Typescript
  • Discord.js v14
  • Mongoose

🚀 Getting started

Here you describe how to run your project locally

Prerequisites

Here you list all prerequisites necessary for running your project.

Cloning

How to clone your project

git clone https://github.com/Nekitori17/Shakiri-Ayui

Config .env variables

Use the .env.example as reference to create your configuration file .env.development for development and .env.production for production with your Discord Bot Token And MongoDB Connection String

# Bot token from discord application
BOT_TOKEN = ""

# Bot ID from discord application
CLIENT_ID = ""

# GEMINI AI API
GEMINI_AI_TOKEN = ""

# Your API url base from nekitori17/fratizy-app
CUSTOM_URL_API_BASE = ""

# # MongoDB connection string
MONGODB_CONNECTION_URI = ""

## Array of user id that can access developer commands. Example: ["123456789","987654321"]
DEVELOPER_ACCOUNT_IDS = ""

# Webhook for logging error.
WEBHOOK_LOG_ERROR_URL = ""

Starting

How to start your project

  • First Install Dependence Packages:
cd Shakiri-Ayui
npm i
  • For Development with .env.development:
npm run dev
  • For Deployment with .env.production:
npm start

📫 Contribute

Here you will explain how other developers can contribute to your project. For example, explaining how can create their branches, which patterns to follow and how to open an pull request

  1. git clone https://github.com/Nekitori17/Shakiri-Ayui
  2. git checkout -b feature/NAME
  3. Follow commit patterns
  4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

Documentations that might help

🤖 DiscordJS Guide

📝 How to create a Pull Request

💾 Commit pattern

About

Discord Bot (WIP)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages