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/.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..79d4f06 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,18 @@ 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. 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` +5. Run `npm run dev` to start the bot in development mode. +6. 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"