From 519bdbf3b4c1eaa6ae77e9cd3ae96ef07a5aebb6 Mon Sep 17 00:00:00 2001 From: mark andro guevarra Date: Sun, 20 Jul 2025 01:54:17 +0200 Subject: [PATCH 1/2] modified README - added how to run the project --- .idea/.gitignore | 8 ++++++++ .idea/inspectionProfiles/Project_Default.xml | 6 ++++++ .idea/modules.xml | 8 ++++++++ .idea/vanilla.iml | 12 ++++++++++++ .idea/vcs.xml | 6 ++++++ README.md | 10 ++++++++++ package-lock.json | 6 +++--- 7 files changed, 53 insertions(+), 3 deletions(-) create mode 100644 .idea/.gitignore create mode 100644 .idea/inspectionProfiles/Project_Default.xml create mode 100644 .idea/modules.xml create mode 100644 .idea/vanilla.iml create mode 100644 .idea/vcs.xml diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..03d9549 --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..a40db86 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vanilla.iml b/.idea/vanilla.iml new file mode 100644 index 0000000..0b872d8 --- /dev/null +++ b/.idea/vanilla.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..c8397c9 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/README.md b/README.md index caf4de3..a2a221e 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,16 @@ Looking forward to see your contribution! 💪 3. Add the command to the `commands` array in the `index.js` file. 4. Run the `npm run deploy-commands` command to deploy the command to the Discord server. +## How to run the project + +1. Run `nvm install` to install the latest LTS version of Node.js. +2. Run `npm install` to install or refresh the project dependencies. +3. Create a `.env` file and configure the required environment variables: + - `DISCORD_TOKEN` + - `GUILD_ID` +4. Run `npm run dev` to start the bot in development mode. +5. Join the Discord server and test the available commands. + ## Contributing If you'd like to help out with the development of this project, please refer to the [contribution guide](./CONTRIBUTING.md). diff --git a/package-lock.json b/package-lock.json index deb2114..de85ac6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -419,9 +419,9 @@ "license": "MIT" }, "node_modules/@types/node": { - "version": "24.0.14", - "resolved": "https://registry.npmjs.org/@types/node/-/node-24.0.14.tgz", - "integrity": "sha512-4zXMWD91vBLGRtHK3YbIoFMia+1nqEz72coM42C5ETjnNCa/heoj7NT1G67iAfOqMmcfhuCZ4uNpyz8EjlAejw==", + "version": "24.0.15", + "resolved": "https://registry.npmjs.org/@types/node/-/node-24.0.15.tgz", + "integrity": "sha512-oaeTSbCef7U/z7rDeJA138xpG3NuKc64/rZ2qmUFkFJmnMsAPaluIifqyWd8hSSMxyP9oie3dLAqYPblag9KgA==", "license": "MIT", "dependencies": { "undici-types": "~7.8.0" From 7006bd55de02c35d8e0c1b066cf2e0b8c1a53925 Mon Sep 17 00:00:00 2001 From: mark andro guevarra Date: Mon, 21 Jul 2025 13:14:21 +0200 Subject: [PATCH 2/2] modified .gitignore & README.md files --- .gitignore | 1 + README.md | 12 +++++++----- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index b90cf49..4ef7c3a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ node_modules .env .vscode +.idea diff --git a/README.md b/README.md index a2a221e..79d4f06 100644 --- a/README.md +++ b/README.md @@ -29,13 +29,15 @@ Looking forward to see your contribution! 💪 ## How to run the project -1. Run `nvm install` to install the latest LTS version of Node.js. -2. Run `npm install` to install or refresh the project dependencies. -3. Create a `.env` file and configure the required environment variables: +1. First of all run the command `rm -rf node_modules` to remove the `node_modules` folder if it exists. This is done to resolve any potential issues with outdated dependencies. + This step is optional but recommended to ensure a clean installation. +2. Run `nvm use` to switch to the correct Node.js version. +3. Run `npm i` to install the required dependencies. +4. Create a `.env` file and configure the required environment variables: - `DISCORD_TOKEN` - `GUILD_ID` -4. Run `npm run dev` to start the bot in development mode. -5. Join the Discord server and test the available commands. +5. Run `npm run dev` to start the bot in development mode. +6. Join the Discord server and test the available commands. ## Contributing