Skip to content

Commit b2da98a

Browse files
committed
Updated docs
1 parent 9cfc608 commit b2da98a

File tree

1 file changed

+57
-15
lines changed

1 file changed

+57
-15
lines changed

CONTRIBUTING.md

Lines changed: 57 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,21 @@ cd advanced-discord-bot
7474
# Install dependencies
7575
npm install
7676

77-
# Copy environment file
77+
# Do the same with server, website, and bot folders
78+
cd server
79+
npm install
80+
81+
cd ../bot
82+
npm install
83+
84+
cd ../website
85+
npm install
86+
87+
# Return to the root directory
88+
cd ..
89+
90+
# Copy environment file (inside the bot folder)
91+
cd bot
7892
cp .env.example .env
7993

8094
# Edit .env with your credentials
@@ -83,11 +97,11 @@ cp .env.example .env
8397
# MONGODB_URI=your_mongodb_uri
8498
# GEMINI_API_KEY=your_gemini_key
8599

86-
# Deploy commands for testing
87-
node deploy-commands.js
100+
# Deploy the commands
101+
npm run deploy
88102

89103
# Start the bot
90-
npm run dev
104+
npm run start:bot
91105
```
92106

93107
### 2. Development Workflow
@@ -163,18 +177,45 @@ git push origin feature/amazing-new-feature
163177
**File Structure:**
164178

165179
```
166-
commands/
167-
├── category/
168-
│ └── command-name.js # Kebab-case naming
169-
events/
170-
├── eventName.js # CamelCase for events
171-
utils/
172-
├── helpers.js # Utility functions
173-
models/
174-
├── schemas.js # Database schemas
180+
advanced-discord-bot/
181+
├── bot/ ----- discord bot related logic and code
182+
│ ├── commands/
183+
│ ├── events/
184+
│ ├── .env
185+
│ ├── .env.example
186+
│ ├── deploy-commands.js
187+
│ ├── index.js
188+
│ ├── package.json
189+
│ ├── setup.bat
190+
│ └── node_modules/
191+
├── screenshots/ ----- showcase the bot
192+
├── server/ ----- server backend and db logic
193+
│ ├── models/
194+
│ ├── utils/
195+
│ ├── index.js
196+
│ └── package.json
197+
├── website/ ----- website code
198+
│ ├── node_modules/
199+
│ ├── public/
200+
│ ├── src/
201+
│ ├── .gitignore
202+
│ ├── eslint.config.js
203+
│ ├── index.html
204+
│ ├── package.json
205+
│ ├── VAISH video.mp4
206+
│ └── vite.config.js
207+
├── .distignore
208+
├── .gitignore
209+
├── CODE_OF_CONDUCT.md
210+
├── CONTRIBUTING.md
211+
├── DOCUMENTATION.md
212+
├── LICENSE
213+
├── package.json
214+
├── README.md
215+
└── release.zip
175216
```
176217

177-
````
218+
178219

179220

180221
**Emoji Usage:**
@@ -263,7 +304,8 @@ Mockups, examples, or references
263304

264305
```bash
265306
# Test in development server
266-
npm run dev
307+
npm run deploy
308+
npm run start:bot
267309

268310
# Test all affected commands
269311
# Verify error handling

0 commit comments

Comments
 (0)