Merge pull request #7 from xN4P4LM-org/xn4p4lm-patch-1

Adding in missing items

Signed-off-by: Diana <dmoore@xn4p4lm.com>

CODEOFCONDUCT.MD

@@ -0,0 +1,31 @@
+# Code of Conduct
+
+## Introduction
+
+We are committed to providing a friendly, safe, and inclusive environment for all participants. This code of conduct outlines our expectations for behavior within our community.
+
+## Expected Behavior
+
+- Be respectful and considerate towards others.
+- Use inclusive language and avoid offensive or discriminatory comments.
+- Be open to different opinions and perspectives.
+- Give credit to others for their contributions.
+- Be mindful of your words and actions, as they can have an impact on others.
+
+## Unacceptable Behavior
+
+The following behaviors are considered unacceptable within our community:
+
+- Harassment, discrimination, or any form of offensive behavior.
+- Intimidation or threats towards others.
+- Disruptive or disrespectful comments or actions.
+- Any form of trolling or personal attacks.
+- Any other behavior that violates the rights of others or creates an unsafe environment.
+
+## Reporting and Enforcement
+
+If you witness or experience any behavior that violates this code of conduct, please report it to the community moderators or administrators. We will review and take appropriate action, which may include warnings, temporary or permanent bans, or other measures.
+
+## Conclusion
+
+By participating in our community, you agree to abide by this code of conduct. We reserve the right to update or modify this code of conduct as needed. Thank you for helping us create a positive and inclusive environment for everyone.

CONTRIBUTING.MD

@@ -0,0 +1,42 @@
+# Contributing to Bot-O-Cat
+
+Thank you for your interest in contributing to Bot-O-Cat! We welcome contributions from the community to help improve our project. Before you get started, please take a moment to review the guidelines below.
+
+## Development Environment
+
+To ensure a consistent development environment, we highly recommend using the included devcontainer for development. The devcontainer provides a pre-configured development environment with all the necessary dependencies and tools.
+
+To use the devcontainer, follow these steps:
+
+1. Fork the Bot-O-Cat repository to your own GitHub account.
+1. Install Docker on your machine if you haven't already.
+1. Clone the Bot-O-Cat repository to your local machine.
+1. Open the project in your preferred code editor.
+1. If prompted, allow the editor to reopen the project in a container.
+1. Wait for the devcontainer to build and start.
+
+By using the devcontainer, you can avoid issues related to different development environments and ensure that your contributions are consistent with the project's standards.
+
+The offically supported code editor is **Visual Studio Code**. If you are using another code editor, you may need to install additional extensions or tools to use the devcontainer and may encounter issues.
+
+## Contributing Guidelines
+
+When contributing to Bot-O-Cat, please keep the following guidelines in mind:
+
+- Before starting work on a new feature or bug fix, please create an issue to discuss the proposed changes with the maintainers.
+- Fork the repository and create a new branch for your changes.
+- Make sure your code follows the project's coding style and conventions.
+- Write clear and concise commit messages.
+- Test your changes thoroughly and ensure that existing tests pass.
+- Submit a pull request with your changes, providing a detailed description of the changes made.
+- Ensure that when submitting code that you have read the [developer-certificate-of-origin](developer-certificate-of-origin) and that you have signed off on your commits with `git commit -s` or `git commit --signoff`.
+
+## Code of Conduct
+
+Please note that Bot-O-Cat has a [Code of Conduct](CONTRIBUTING.MD). By participating in this project, you are expected to uphold the code of conduct and treat all contributors with respect.
+
+## Getting Help
+
+If you have any questions or need assistance, feel free to reach out to the maintainers or the community. We are here to help!
+
+Thank you for your contributions and happy coding!

README.md

@@ -1,11 +1,104 @@
-# Bot-O-Cat: Bot - This is the bot portion of the [Bot-O-Cat](https://github.com/xN4P4LM-org/bot-o-cat)
+# Bot-O-Cat
 
-[![Linting](https://github.com/xN4P4LM-org/bot-o-cat_bot/actions/workflows/lint.yaml/badge.svg)](https://github.com/xN4P4LM-org/bot-o-cat_bot/actions/workflows/lint.yaml)
+[![Linting](https://github.com/xN4P4LM-org/bot-o-cat/actions/workflows/lint.yaml/badge.svg)](https://github.com/xN4P4LM-org/bot-o-cat/actions/workflows/lint.yaml)
 
-## Contributing guidelines
+### ( This is a work in progress - use at your own risk )
 
-If you would like to contribute to the project, please navigate to the [Bot-O-Cat](https://github.com/xN4P4LM-org/bot-o-cat) repository and follow the [CONTRIBUTING.md](https://github.com/xN4P4LM-org/bot-o-cat/blob/main/CONTRIBUTING.md) guidelines.
+## Overview
 
-## Running the bot standalone (Optional)
+This is a general purpose bot where the primary intention is to enable server owners, as well as third parties to create a bot that is tailored to their specific need or uses cases. The bot is designed to be modular. You can add new features and functionality without the need to modify the core codebase or you can create your own bot using this as a framework.
 
-You can run the bot standalone with the following dockerfile:
+## Features
+
+This is also part of a comprehensive service, more information can be found over on the service's page: [discord-bot-o-cat-service](https://github.com/xN4P4LM-org/discord-bot-o-cat-service)
+
+## Running the bot
+
+To run this bot you will use the following `docker-compose` file and a docker compatible environment.
+
+```yaml
+version: "3"
+services:
+  bot:
+    container_name: discord-bot
+    build: ./bot
+    environment:
+      - DISCORD_BOT_DESCRIPTION="A simple discord bot"
+      - DISCORD_BOT_TOKEN=
+      - DISCORD_BOT_OWNER_ID=
+      - DISCORD_BOT_COMMAND_PREFIX=.
+      - DISCORD_BOT_LOG_LEVEL=20 # 10=DEBUG, 20=INFO, 30=WARNING, 40=ERROR, 50=CRITICAL
+      - DISCORD_MONGO_DB_HOST_NAME=mongo-db
+      - DISCORD_MONGO_DB_PORT=27017
+    volumes:
+      - discord_cogs:/bot/cogs
+      - discord_git_ssh:/root/.ssh
+    depends_on:
+      mongo-db:
+        condition: service_healthy
+        restart: true
+
+  mongo-db:
+    container_name: discord-mongodb
+    build: ./db
+    environment:
+      - MONGO_INITDB_ROOT_USERNAME=
+      - MONGO_INITDB_ROOT_PASSWORD=
+    volumes:
+      - discord_db:/data/db
+    healthcheck:
+      test: mongosh mongo-db:27017/test --tls --tlsCertificateKeyFile /etc/ssl/mongo-db.pem --tlsCAFile /etc/ssl/ca.pem --quiet --eval 'db.runCommand({ping:1})'
+      interval: 10s
+      timeout: 5s
+      retries: 3
+      start_period: 5s
+
+  # api:
+  #   container_name: discord-api
+  #   build: ./api
+  #   environment:
+  #     - API_PORT=8443
+  #   ports:
+  #     - "8443:8443"
+  #   volumes:
+  #     - discord_api_ssl_certs:/etc/letsencrypt/live/
+
+  # api:
+  #   container_name: discord-web
+  #   build: ./web
+  #   environment:
+  #     - WEB_PORT=8443
+  #   ports:
+  #     - "8443:8443"
+  #   volumes:
+  #     - discord_web_ssl_certs:/etc/letsencrypt/live/
+
+volumes:
+  discord_cogs:
+  discord_git_ssh:
+  discord_db:
+  #discord_api_ssl_certs:
+  #discord_web_ssl_certs:
+```
+
+## Required environment variables
+
+- `DISCORD_BOT_DESCRIPTION` - The description of the bot
+- `DISCORD_BOT_TOKEN` - Discord Token for your bot from the Discord Developer Portal
+- `DISCORD_BOT_OWNER_ID` - The Bot Owner's user id
+- `DISCORD_BOT_COMMAND_PREFIX` - Command Prefix Ex. `!`
+- `DISCORD_BOT_LOG_LEVEL` - the int log level `(10, 20, 30, 40, 50)`
+- `MONGO_INITDB_ROOT_USERNAME` - The root user for MongoDB
+- `MONGO_INITDB_ROOT_PASSWORD` - The root password for MongoDB
+
+# Contributing
+
+If you would like to contribute to the project, please read both the [CONTRIBUTING.md](CONTRIBUTING.md) and the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) guidelines.
+
+Features request can be submitted by using [GitHub Issues](https://github.com/xn4p4lm-org/bot-o-cat/issues).
+
+All code, comments, and critiques are greatly appreciated.
+
+# License
+
+Bot-O-Cat and all components are licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full license text.

developer-certificate-of-origin

@@ -0,0 +1,34 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.