Skip to content

modified README - added how to run the project #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
spacemark3 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

modified README - added how to run the project #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
519bdbf
modified README - added how to run the project
Jul 19, 2025
7006bd5
modified .gitignore & README.md files
Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
node_modules
.env
.vscode
.idea
8 changes: 8 additions & 0 deletions .idea/.gitignore
View file
Open in desktop
Copy link
Copy Markdown
Member

@MindfulLearner MindfulLearner Jul 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no needed

use .gitignore or just delete them.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/inspectionProfiles/Project_Default.xml
View file
Open in desktop
Comment thread
MindfulLearner marked this conversation as resolved.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml
View file
Open in desktop
Comment thread
MindfulLearner marked this conversation as resolved.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions .idea/vanilla.iml
View file
Open in desktop
Comment thread
MindfulLearner marked this conversation as resolved.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml
View file
Open in desktop
Comment thread
MindfulLearner marked this conversation as resolved.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
6 changes: 3 additions & 3 deletions package-lock.json
View file
Open in desktop
Copy link
Copy Markdown
Member

@MindfulLearner MindfulLearner Jul 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do first:

rm -rf node_modules

then

nvm use

then

npm install

and push

Copy link
Copy Markdown
Member

@MindfulLearner MindfulLearner Jul 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need package json to be the same as main

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading