Skip to content

Commit 6a00e98

Browse files
committed
updated the structure
1 parent ac68989 commit 6a00e98

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+76
-6115
lines changed

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
build
2+
dist
23
node_modules
3-
# modules
4-
# index.js
5-
# index.d.ts
64
.codeboltAgents

Readme.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,53 @@ const codebolt = require('@codebolt/codeboltjs');
2121
// Your code here
2222
```
2323

24+
## Development
25+
26+
### Building the Project
27+
28+
```bash
29+
# Install dependencies
30+
npm install
31+
32+
# Build TypeScript to dist/ (recommended for development)
33+
npm run build
34+
35+
# Build webpack bundle to build/bundle.js (single file for distribution)
36+
npm run build:webpack
37+
38+
# Build both TypeScript and webpack versions
39+
npm run build:all
40+
41+
# Clean all build artifacts
42+
npm run clean
43+
44+
# Build documentation
45+
npm run build:docs
46+
```
47+
48+
### Build Outputs
49+
50+
The project supports two build methods:
51+
52+
1. **TypeScript Build** (`npm run build`)
53+
- Outputs to `dist/` directory
54+
- Preserves module structure
55+
- Includes separate `.js` and `.d.ts` files
56+
- **Recommended for npm publishing and development**
57+
58+
2. **Webpack Build** (`npm run build:webpack`)
59+
- Outputs to `build/bundle.js`
60+
- Single bundled file
61+
- Optimized for production deployment
62+
- **Works in Node.js environments**
63+
64+
### Project Structure
65+
66+
- `src/` - TypeScript source code
67+
- `dist/` - Compiled JavaScript and type definitions (generated by TypeScript)
68+
- `build/` - Webpack bundle (generated by webpack)
69+
- `docs/` - Generated documentation
70+
2471
## Documentation
2572

2673
For More Documentation visit [Codebolt's Documentation](https://docs.codebolt.ai)

index.d.ts

Lines changed: 0 additions & 262 deletions
This file was deleted.

0 commit comments

Comments
 (0)