Pokémon Kingdom Staff Management

Base code for "Pokémon Kingdom Staff Management" Discord bot

Explore the docs »

View Demo . Report Bug . Request Feature

Table Of Contents

• Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

Built With

• Node.JS
• Discord.JS

Getting Started

To get a local copy of the bot up and running follow these steps.

Prerequisites

• npm

npm install npm@latest -g

• pm2 (optional)

npm install pm2 -g

Installation

1. Clone the repo

git clone https://github.com/Bartolumiu/pkStaffManagement.git

2. Install NPM packages

npm install

3. Rename .env.template to .env and enter the following:

token=ULTRA_SECRET_BOT_TOKEN
ownerId=01234567891011121314
databaseToken=mongodbtoken
clientId=0123456789011121314

4. Start the bot

4.1. Node:

node src/bot.js

4.2. npm command

npm run test

4.3. pm2 (recommended)

pm2 start src/bot.js

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.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

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 Apache License 2.0. See LICENSE for more information.

Authors

• Bartolumiu - Main Developer