Welcome to the SecMX project repository! This project is a Discord bot that integrates with a website. It includes the bot’s logic, web interface, and configuration files to run both components.
The repository contains the following key components:
- commands: Stores the command files that control the behavior of the Discord bot.
- configs: Includes configuration files for both the bot and website setup.
- node_modules: The directory for all installed dependencies.
- public: Contains publicly accessible files, such as images, stylesheets, and JavaScript files for the website.
- views: Stores the view templates used to render the website.
- .env: Environment variables used for configuration (for bot tokens, API keys, etc.).
- .gitattributes: Git attributes for managing the repository.
- server.js: The main server file where both the bot and website are started and managed.
- start.bat: A batch script to start the application.
- installer.bat: A batch script for installing dependencies.
- devstart.bat: A batch script for starting the development environment.
- open vscode.bat: A batch script to open the project in Visual Studio Code.
- package.json: Defines the project metadata and installed dependencies.
- package-lock.json: Ensures consistent dependency installation.
To get started with this project, you need to install the required dependencies.
- Clone this repository:
git clone https://github.com/bilalchentouf7/SecMX.git
- Navigate to the project directory:
cd SecMX - Install the dependencies:
npm install
After installation, you can run the project using the following commands:
-
Development Mode:
To start the development environment, run:npm run dev
Alternatively, you can use the provided
devstart.batscript. -
Production Mode:
To start the bot and website in production mode, run:npm start
Alternatively, you can use the provided
start.batscript.
Make sure to set up your environment variables in the .env file. Here's an example:
DISCORD_TOKEN=your_discord_bot_token
CLIENT_ID=your_discord_client_id
CLIENT_SECRET=your_discord_client_secret
PORT=your_preferred_port- devstart.bat: Starts the development environment with necessary configurations.
- installer.bat: Installs the necessary dependencies for the project.
- start.bat: Starts the application in production mode.
- open vscode.bat: Opens the project directly in Visual Studio Code.
The repository includes the following images:
- Vlogo.png: Project logo. (normal logo)
- download.png: Download-related image.
- logo.png: Another logo image. ( circle logo )
- secmcbanner.png: Banner for SecMX. ( bot banner )
We welcome contributions to the project! To contribute, follow these steps:
- Fork this repository.
- Create a new branch.
- Make your changes.
- Open a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.