@bouygues-telecom/staticjs 0.1.11 → 0.1.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/_build/helpers/cachePages.d.ts +15 -0
  2. package/_build/helpers/cachePages.js +162 -0
  3. package/_build/helpers/createPage.d.ts +18 -0
  4. package/_build/helpers/createPage.js +41 -0
  5. package/_build/helpers/layoutDiscovery.d.ts +9 -0
  6. package/_build/helpers/layoutDiscovery.js +39 -0
  7. package/_build/helpers/readPages.d.ts +3 -0
  8. package/_build/helpers/readPages.js +24 -0
  9. package/_build/helpers/renderPageRuntime.d.ts +13 -0
  10. package/_build/helpers/renderPageRuntime.js +222 -0
  11. package/_build/scripts/build-html.d.ts +1 -0
  12. package/_build/scripts/build-html.js +138 -0
  13. package/_build/scripts/cli.d.ts +6 -0
  14. package/_build/scripts/cli.js +119 -0
  15. package/_build/scripts/create-static-app.d.ts +2 -0
  16. package/{dist → _build}/scripts/create-static-app.js +0 -0
  17. package/_build/scripts/generate-test-multiapps.d.ts +6 -0
  18. package/_build/scripts/generate-test-multiapps.js +79 -0
  19. package/_build/server/config/index.d.ts +20 -0
  20. package/_build/server/config/index.js +25 -0
  21. package/_build/server/config/vite.config.d.ts +2 -0
  22. package/_build/server/config/vite.config.js +31 -0
  23. package/_build/server/config/vite.plugin.d.ts +11 -0
  24. package/_build/server/config/vite.plugin.js +75 -0
  25. package/_build/server/index.d.ts +22 -0
  26. package/_build/server/index.js +124 -0
  27. package/_build/server/middleware/errorHandling.d.ts +22 -0
  28. package/_build/server/middleware/errorHandling.js +48 -0
  29. package/_build/server/middleware/hotReload.d.ts +31 -0
  30. package/_build/server/middleware/hotReload.js +152 -0
  31. package/_build/server/middleware/logging.d.ts +13 -0
  32. package/_build/server/middleware/logging.js +23 -0
  33. package/_build/server/middleware/parsing.d.ts +9 -0
  34. package/_build/server/middleware/parsing.js +21 -0
  35. package/_build/server/middleware/performance.d.ts +13 -0
  36. package/_build/server/middleware/performance.js +26 -0
  37. package/_build/server/middleware/rateLimiting.d.ts +17 -0
  38. package/_build/server/middleware/rateLimiting.js +38 -0
  39. package/_build/server/middleware/runtime.d.ts +23 -0
  40. package/_build/server/middleware/runtime.js +186 -0
  41. package/_build/server/middleware/security.d.ts +24 -0
  42. package/_build/server/middleware/security.js +39 -0
  43. package/_build/server/middleware/static.d.ts +9 -0
  44. package/_build/server/middleware/static.js +63 -0
  45. package/_build/server/routes/api.d.ts +23 -0
  46. package/_build/server/routes/api.js +124 -0
  47. package/_build/server/scripts/revalidate.d.ts +2 -0
  48. package/{dist → _build/server}/scripts/revalidate.js +3 -3
  49. package/_build/server/utils/fileWatcher.d.ts +27 -0
  50. package/_build/server/utils/fileWatcher.js +194 -0
  51. package/_build/server/utils/startup.d.ts +18 -0
  52. package/_build/server/utils/startup.js +93 -0
  53. package/_build/server/utils/vite.d.ts +18 -0
  54. package/_build/server/utils/vite.js +61 -0
  55. package/_build/server/utils/websocket.d.ts +26 -0
  56. package/_build/server/utils/websocket.js +140 -0
  57. package/package.json +28 -16
  58. package/LICENSE +0 -190
  59. package/README.md +0 -158
  60. package/dist/config/vite.plugin.js +0 -80
  61. package/dist/helpers/cachePages.js +0 -26
  62. package/dist/helpers/createPage.js +0 -23
  63. package/dist/helpers/readPages.js +0 -19
  64. package/dist/scripts/build-html.js +0 -82
  65. package/dist/scripts/cli.js +0 -36
  66. package/dist/scripts/generate-test-multiapps.js +0 -51
@@ -0,0 +1,61 @@
1
+ /**
2
+ * Vite server utilities
3
+ * Handles Vite server initialization and JavaScript serving for development mode
4
+ */
5
+ import { createServer as createViteServer } from "vite";
6
+ import { isDevelopment } from "../config/index.js";
7
+ import { registerJavaScriptMiddleware } from "../middleware/runtime.js";
8
+ let viteServer = null;
9
+ /**
10
+ * Initialize Vite server for development mode
11
+ */
12
+ export const initializeViteServer = async (app) => {
13
+ if (isDevelopment) {
14
+ // Check if Vite server is already initialized
15
+ if (viteServer) {
16
+ // Vite server already initialized
17
+ return viteServer;
18
+ }
19
+ try {
20
+ // Initializing Vite server
21
+ // Create Vite server for development mode JS compilation
22
+ viteServer = await createViteServer({
23
+ server: {
24
+ middlewareMode: true,
25
+ hmr: {
26
+ port: 24679 // Use different port to avoid conflicts
27
+ }
28
+ },
29
+ appType: 'custom',
30
+ configFile: '../../lib/server/config/vite.config.ts'
31
+ });
32
+ // Vite server initialized
33
+ // Add Vite's middleware to handle dependency requests
34
+ app.use(viteServer.middlewares);
35
+ // Register JavaScript serving middleware after Vite server is ready
36
+ registerJavaScriptMiddleware(app, viteServer);
37
+ }
38
+ catch (error) {
39
+ console.error('❌ Failed to initialize Vite server:', error);
40
+ }
41
+ }
42
+ return viteServer;
43
+ };
44
+ /**
45
+ * Get the current Vite server instance
46
+ */
47
+ export const getViteServer = () => viteServer;
48
+ /**
49
+ * Close the Vite server
50
+ */
51
+ export const closeViteServer = async () => {
52
+ if (viteServer) {
53
+ try {
54
+ await viteServer.close();
55
+ // Vite server closed
56
+ }
57
+ catch (error) {
58
+ console.error('❌ Error closing Vite server:', error);
59
+ }
60
+ }
61
+ };
@@ -0,0 +1,26 @@
1
+ /**
2
+ * WebSocket server utilities for hot reloading
3
+ * Handles WebSocket connections and broadcasting reload messages
4
+ */
5
+ import { WebSocketServer } from 'ws';
6
+ import { Server as HttpServer } from 'http';
7
+ /**
8
+ * Initialize WebSocket server attached to HTTP server
9
+ */
10
+ export declare const initializeWebSocketServer: (httpServer: HttpServer) => WebSocketServer | null;
11
+ /**
12
+ * Broadcast reload message to all connected clients
13
+ */
14
+ export declare const broadcastReload: (type?: string, data?: Record<string, any>) => void;
15
+ /**
16
+ * Get current WebSocket server instance
17
+ */
18
+ export declare const getWebSocketServer: () => WebSocketServer | null;
19
+ /**
20
+ * Get number of connected clients
21
+ */
22
+ export declare const getConnectedClientsCount: () => number;
23
+ /**
24
+ * Close WebSocket server and cleanup
25
+ */
26
+ export declare const closeWebSocketServer: () => Promise<void>;
@@ -0,0 +1,140 @@
1
+ /**
2
+ * WebSocket server utilities for hot reloading
3
+ * Handles WebSocket connections and broadcasting reload messages
4
+ */
5
+ import { WebSocketServer, WebSocket } from 'ws';
6
+ import { isDevelopment } from '../config/index.js';
7
+ let wss = null;
8
+ let clients = new Set();
9
+ /**
10
+ * Initialize WebSocket server attached to HTTP server
11
+ */
12
+ export const initializeWebSocketServer = (httpServer) => {
13
+ if (!isDevelopment) {
14
+ // Skipping WebSocket server in production mode
15
+ return null;
16
+ }
17
+ try {
18
+ // Create WebSocket server attached to HTTP server
19
+ wss = new WebSocketServer({
20
+ server: httpServer,
21
+ path: '/ws'
22
+ });
23
+ wss.on('connection', (ws, req) => {
24
+ // Client connected
25
+ clients.add(ws);
26
+ // Send welcome message
27
+ ws.send(JSON.stringify({
28
+ type: 'connected',
29
+ message: 'Hot reload client connected'
30
+ }));
31
+ // Handle client disconnect
32
+ ws.on('close', () => {
33
+ // Client disconnected
34
+ clients.delete(ws);
35
+ });
36
+ // Handle client errors
37
+ ws.on('error', (error) => {
38
+ console.error('[WebSocket] Client error:', error);
39
+ clients.delete(ws);
40
+ });
41
+ // Handle ping/pong for connection health
42
+ ws.on('pong', () => {
43
+ ws.isAlive = true;
44
+ });
45
+ });
46
+ // Setup ping interval to detect dead connections
47
+ const pingInterval = setInterval(() => {
48
+ if (wss && wss.clients) {
49
+ wss.clients.forEach((ws) => {
50
+ if (ws.isAlive === false) {
51
+ clients.delete(ws);
52
+ return ws.terminate();
53
+ }
54
+ ws.isAlive = false;
55
+ ws.ping();
56
+ });
57
+ }
58
+ }, 30000); // 30 seconds
59
+ wss.on('close', () => {
60
+ clearInterval(pingInterval);
61
+ });
62
+ // WebSocket server initialized
63
+ return wss;
64
+ }
65
+ catch (error) {
66
+ console.error('[WebSocket] Failed to initialize WebSocket server:', error);
67
+ return null;
68
+ }
69
+ };
70
+ /**
71
+ * Broadcast reload message to all connected clients
72
+ */
73
+ export const broadcastReload = (type = 'page', data = {}) => {
74
+ if (!isDevelopment) {
75
+ return;
76
+ }
77
+ if (!wss) {
78
+ // WebSocket server not initialized
79
+ return;
80
+ }
81
+ const message = {
82
+ type: 'reload',
83
+ reloadType: type,
84
+ timestamp: Date.now(),
85
+ data
86
+ };
87
+ const messageString = JSON.stringify(message);
88
+ let sentCount = 0;
89
+ let deadConnections = 0;
90
+ clients.forEach((ws) => {
91
+ if (ws.readyState === WebSocket.OPEN) {
92
+ try {
93
+ ws.send(messageString);
94
+ sentCount++;
95
+ }
96
+ catch (error) {
97
+ console.error('[WebSocket] Error sending message to client:', error);
98
+ clients.delete(ws);
99
+ deadConnections++;
100
+ }
101
+ }
102
+ else {
103
+ clients.delete(ws);
104
+ deadConnections++;
105
+ }
106
+ });
107
+ // Reload broadcast completed (silent)
108
+ };
109
+ /**
110
+ * Get current WebSocket server instance
111
+ */
112
+ export const getWebSocketServer = () => wss;
113
+ /**
114
+ * Get number of connected clients
115
+ */
116
+ export const getConnectedClientsCount = () => clients.size;
117
+ /**
118
+ * Close WebSocket server and cleanup
119
+ */
120
+ export const closeWebSocketServer = async () => {
121
+ if (!wss) {
122
+ return;
123
+ }
124
+ return new Promise((resolve) => {
125
+ // Closing WebSocket server
126
+ // Close all client connections
127
+ clients.forEach((ws) => {
128
+ if (ws.readyState === WebSocket.OPEN) {
129
+ ws.close(1000, 'Server shutting down');
130
+ }
131
+ });
132
+ clients.clear();
133
+ // Close the server
134
+ wss.close(() => {
135
+ // WebSocket server closed
136
+ wss = null;
137
+ resolve();
138
+ });
139
+ });
140
+ };
package/package.json CHANGED
@@ -1,43 +1,55 @@
1
1
  {
2
2
  "name": "@bouygues-telecom/staticjs",
3
- "version": "0.1.11",
3
+ "version": "0.1.15",
4
4
  "type": "module",
5
+ "main": "./_build/server/index.js",
6
+ "exports": {
7
+ ".": "./_build/server/index.js",
8
+ "./server": "./_build/server/index.js",
9
+ "./config": "./_build/server/config/index.js",
10
+ "./helpers": "./_build/helpers/cachePages.js"
11
+ },
5
12
  "files": [
6
- "dist",
13
+ "_build",
7
14
  "package.json",
8
15
  "README.md"
9
16
  ],
10
17
  "bin": {
11
- "create-staticjs-app": "./dist/scripts/create-static-app.js",
12
- "bt-staticjs": "./dist/scripts/cli.js",
13
- "generate-test-multiapps": "./dist/scripts/generate-test-multiapps.js"
18
+ "create-staticjs-app": "./_build/scripts/create-static-app.js",
19
+ "bt-staticjs": "./_build/scripts/cli.js",
20
+ "static": "./_build/scripts/cli.js",
21
+ "generate-test-multiapps": "./_build/scripts/generate-test-multiapps.js"
14
22
  },
15
23
  "scripts": {
16
- "prebuild": "tsc -p ./tsconfig.json",
17
- "build": "cd templates/react && rimraf dist && rimraf cache && node ../../dist/helpers/cachePages.js && vite build --config ../../vite.config.js && tsx ../../dist/scripts/build-html.js",
18
- "generate:test": "cd templates/react && node ../../scripts/generate-test-multiapps.js",
19
- "start": "cd templates/react && npm start"
24
+ "build": "rm -rf _build && tsc && chmod +x _build/scripts/*.js",
25
+ "dev": "npm run build && cd ../templates/react && npm run dev"
20
26
  },
21
27
  "dependencies": {
22
- "@types/node": "^20",
28
+ "chokidar": "^4.0.1",
23
29
  "cli-spinner": "^0.2.10",
24
30
  "commander": "^14.0.0",
31
+ "compression": "^1.7.5",
32
+ "cors": "^2.8.5",
33
+ "express": "^5.0.1",
34
+ "express-rate-limit": "^8.0.1",
25
35
  "giget": "^2.0.0",
36
+ "helmet": "^8.0.0",
26
37
  "nodemon": "^3.1.10",
27
38
  "path": "^0.12.7",
28
39
  "readline": "^1.3.0",
29
40
  "rimraf": "^6.0.1",
30
- "tsx": "^4.19.4",
31
- "typescript": "^5"
41
+ "ws": "^8.18.0"
32
42
  },
33
43
  "volta": {
34
44
  "node": "24.1.0"
35
45
  },
36
- "workspaces": [
37
- "templates/react"
38
- ],
39
46
  "devDependencies": {
47
+ "@types/chokidar": "^2.1.7",
40
48
  "@types/cli-spinner": "^0.2.3",
41
- "@types/express": "^5.0.3"
49
+ "@types/compression": "^1.8.1",
50
+ "@types/cors": "^2.8.19",
51
+ "@types/express": "^5.0.3",
52
+ "@types/helmet": "^4.0.0",
53
+ "@types/ws": "^8.18.1"
42
54
  }
43
55
  }
package/LICENSE DELETED
@@ -1,190 +0,0 @@
1
- Apache License
2
- Version 2.0, January 2004
3
- http://www.apache.org/licenses/
4
-
5
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
-
7
- 1. Definitions.
8
-
9
- "License" shall mean the terms and conditions for use, reproduction,
10
- and distribution as defined by Sections 1 through 9 of this document.
11
-
12
- "Licensor" shall mean the copyright owner or entity authorized by
13
- the copyright owner that is granting the License.
14
-
15
- "Legal Entity" shall mean the union of the acting entity and all
16
- other entities that control, are controlled by, or are under common
17
- control with that entity. For the purposes of this definition,
18
- "control" means (i) the power, direct or indirect, to cause the
19
- direction or management of such entity, whether by contract or
20
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
- outstanding shares, or (iii) beneficial ownership of such entity.
22
-
23
- "You" (or "Your") shall mean an individual or Legal Entity
24
- exercising permissions granted by this License.
25
-
26
- "Source" form shall mean the preferred form for making modifications,
27
- including but not limited to software source code, documentation
28
- source, and configuration files.
29
-
30
- "Object" form shall mean any form resulting from mechanical
31
- transformation or translation of a Source form, including but
32
- not limited to compiled object code, generated documentation,
33
- and conversions to other media types.
34
-
35
- "Work" shall mean the work of authorship, whether in Source or
36
- Object form, made available under the License, as indicated by a
37
- copyright notice that is included in or attached to the work
38
- (an example is provided in the Appendix below).
39
-
40
- "Derivative Works" shall mean any work, whether in Source or Object
41
- form, that is based on (or derived from) the Work and for which the
42
- editorial revisions, annotations, elaborations, or other modifications
43
- represent, as a whole, an original work of authorship. For the purposes
44
- of this License, Derivative Works shall not include works that remain
45
- separable from, or merely link (or bind by name) to the interfaces of,
46
- the Work and Derivative Works thereof.
47
-
48
- "Contribution" shall mean any work of authorship, including
49
- the original version of the Work and any modifications or additions
50
- to that Work or Derivative Works thereof, that is intentionally
51
- submitted to Licensor for inclusion in the Work by the copyright owner
52
- or by an individual or Legal Entity authorized to submit on behalf of
53
- the copyright owner. For the purposes of this definition, "submitted"
54
- means any form of electronic, verbal, or written communication sent
55
- to the Licensor or its representatives, including but not limited to
56
- communication on electronic mailing lists, source code control systems,
57
- and issue tracking systems that are managed by, or on behalf of, the
58
- Licensor for the purpose of discussing and improving the Work, but
59
- excluding communication that is conspicuously marked or otherwise
60
- designated in writing by the copyright owner as "Not a Contribution."
61
-
62
- "Contributor" shall mean Licensor and any individual or Legal Entity
63
- on behalf of whom a Contribution has been received by Licensor and
64
- subsequently incorporated within the Work.
65
-
66
- 2. Grant of Copyright License. Subject to the terms and conditions of
67
- this License, each Contributor hereby grants to You a perpetual,
68
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
- copyright license to reproduce, prepare Derivative Works of,
70
- publicly display, publicly perform, sublicense, and distribute the
71
- Work and such Derivative Works in Source or Object form.
72
-
73
- 3. Grant of Patent License. Subject to the terms and conditions of
74
- this License, each Contributor hereby grants to You a perpetual,
75
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
- (except as stated in this section) patent license to make, have made,
77
- use, offer to sell, sell, import, and otherwise transfer the Work,
78
- where such license applies only to those patent claims licensable
79
- by such Contributor that are necessarily infringed by their
80
- Contribution(s) alone or by combination of their Contribution(s)
81
- with the Work to which such Contribution(s) was submitted. If You
82
- institute patent litigation against any entity (including a
83
- cross-claim or counterclaim in a lawsuit) alleging that the Work
84
- or a Contribution incorporated within the Work constitutes direct
85
- or contributory patent infringement, then any patent licenses
86
- granted to You under this License for that Work shall terminate
87
- as of the date such litigation is filed.
88
-
89
- 4. Redistribution. You may reproduce and distribute copies of the
90
- Work or Derivative Works thereof in any medium, with or without
91
- modifications, and in Source or Object form, provided that You
92
- meet the following conditions:
93
-
94
- (a) You must give any other recipients of the Work or
95
- Derivative Works a copy of this License; and
96
-
97
- (b) You must cause any modified files to carry prominent notices
98
- stating that You changed the files; and
99
-
100
- (c) You must retain, in the Source form of any Derivative Works
101
- that You distribute, all copyright, patent, trademark, and
102
- attribution notices from the Source form of the Work,
103
- excluding those notices that do not pertain to any part of
104
- the Derivative Works; and
105
-
106
- (d) If the Work includes a "NOTICE" text file as part of its
107
- distribution, then any Derivative Works that You distribute must
108
- include a readable copy of the attribution notices contained
109
- within such NOTICE file, excluding those notices that do not
110
- pertain to any part of the Derivative Works, in at least one
111
- of the following places: within a NOTICE text file distributed
112
- as part of the Derivative Works; within the Source form or
113
- documentation, if provided along with the Derivative Works; or,
114
- within a display generated by the Derivative Works, if and
115
- wherever such third-party notices normally appear. The contents
116
- of the NOTICE file are for informational purposes only and
117
- do not modify the License. You may add Your own attribution
118
- notices within Derivative Works that You distribute, alongside
119
- or as an addendum to the NOTICE text from the Work, provided
120
- that such additional attribution notices cannot be construed
121
- as modifying the License.
122
-
123
- You may add Your own copyright statement to Your modifications and
124
- may provide additional or different license terms and conditions
125
- for use, reproduction, or distribution of Your modifications, or
126
- for any such Derivative Works as a whole, provided Your use,
127
- reproduction, and distribution of the Work otherwise complies with
128
- the conditions stated in this License.
129
-
130
- 5. Submission of Contributions. Unless You explicitly state otherwise,
131
- any Contribution intentionally submitted for inclusion in the Work
132
- by You to the Licensor shall be under the terms and conditions of
133
- this License, without any additional terms or conditions.
134
- Notwithstanding the above, nothing herein shall supersede or modify
135
- the terms of any separate license agreement you may have executed
136
- with Licensor regarding such Contributions.
137
-
138
- 6. Trademarks. This License does not grant permission to use the trade
139
- names, trademarks, service marks, or product names of the Licensor,
140
- except as required for reasonable and customary use in describing the
141
- origin of the Work and reproducing the content of the NOTICE file.
142
-
143
- 7. Disclaimer of Warranty. Unless required by applicable law or
144
- agreed to in writing, Licensor provides the Work (and each
145
- Contributor provides its Contributions) on an "AS IS" BASIS,
146
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
- implied, including, without limitation, any warranties or conditions
148
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
- PARTICULAR PURPOSE. You are solely responsible for determining the
150
- appropriateness of using or redistributing the Work and assume any
151
- risks associated with Your exercise of permissions under this License.
152
-
153
- 8. Limitation of Liability. In no event and under no legal theory,
154
- whether in tort (including negligence), contract, or otherwise,
155
- unless required by applicable law (such as deliberate and grossly
156
- negligent acts) or agreed to in writing, shall any Contributor be
157
- liable to You for damages, including any direct, indirect, special,
158
- incidental, or consequential damages of any character arising as a
159
- result of this License or out of the use or inability to use the
160
- Work (including but not limited to damages for loss of goodwill,
161
- work stoppage, computer failure or malfunction, or any and all
162
- other commercial damages or losses), even if such Contributor
163
- has been advised of the possibility of such damages.
164
-
165
- 9. Accepting Warranty or Additional Liability. While redistributing
166
- the Work or Derivative Works thereof, You may choose to offer,
167
- and charge a fee for, acceptance of support, warranty, indemnity,
168
- or other liability obligations and/or rights consistent with this
169
- License. However, in accepting such obligations, You may act only
170
- on Your own behalf and on Your sole responsibility, not on behalf
171
- of any other Contributor, and only if You agree to indemnify,
172
- defend, and hold each Contributor harmless for any liability
173
- incurred by, or claims asserted against, such Contributor by reason
174
- of your accepting any such warranty or additional liability.
175
-
176
- END OF TERMS AND CONDITIONS
177
-
178
- Copyright 2024 Bouygues Telecom
179
-
180
- Licensed under the Apache License, Version 2.0 (the "License");
181
- you may not use this file except in compliance with the License.
182
- You may obtain a copy of the License at
183
-
184
- http://www.apache.org/licenses/LICENSE-2.0
185
-
186
- Unless required by applicable law or agreed to in writing, software
187
- distributed under the License is distributed on an "AS IS" BASIS,
188
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
- See the License for the specific language governing permissions and
190
- limitations under the License.
package/README.md DELETED
@@ -1,158 +0,0 @@
1
- <div align="center">
2
-
3
- # 🚀 StaticJS
4
-
5
- **A modern React boilerplate for creating static projects**
6
-
7
- [![npm version](https://badge.fury.io/js/%40bouygues-telecom%2Fstaticjs.svg)](https://badge.fury.io/js/%40bouygues-telecom%2Fstaticjs)
8
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
9
- [![Node.js Version](https://img.shields.io/badge/node-%3E%3D16.0.0-brightgreen.svg)](https://nodejs.org/)
10
-
11
- _Start your static projects in seconds with an optimized architecture_
12
-
13
- [Installation](#-installation) • [Usage](#-usage) • [Features](#-features) • [Examples](#-examples)
14
-
15
- </div>
16
-
17
- ## 📖 Table of Contents
18
-
19
- - [🎯 About](#-about)
20
- - [✨ Features](#-features)
21
- - [🚀 Installation](#-installation)
22
- - [📘 Usage](#-usage)
23
- - [🔄 Revalidation](#-revalidation)
24
- - [⚙️ Configuration](#️-configuration)
25
- - [📚 Examples](#-examples)
26
- - [📄 License](#-license)
27
-
28
- ## 🎯 About
29
-
30
- **StaticJS** is a powerful and modern boilerplate designed for creating static projects. It integrates development best practices and offers advanced features like specific page revalidation.
31
-
32
- ### Why StaticJS?
33
-
34
- - ⚡ **Ultra-fast startup** - Initialize your project in seconds
35
- - 🔄 **Smart revalidation** - Rebuild specific pages on demand
36
- - 🏗️ **Modern architecture** - Optimized and maintainable project structure
37
- - 🚀 **Production ready** - Production-ready configuration
38
- - 📱 **Responsive** - Native support for all devices
39
-
40
- ## ✨ Features
41
-
42
- | Feature | Description |
43
- | ----------------------------- | ---------------------------------------------- |
44
- | 🚀 **Fast generation** | Project creation with a single command |
45
- | 🔄 **Hot Reloading** | Automatic reload during development |
46
- | 📦 **Optimized build** | Production-optimized bundle |
47
- | 🎯 **Targeted revalidation** | Specific page reconstruction via API |
48
- | 🛠️ **Flexible configuration** | Advanced customization according to your needs |
49
- | 📊 **Performance** | Automatic performance optimizations |
50
-
51
- ## 🚀 Installation
52
-
53
- ### Prerequisites
54
-
55
- - Node.js >= 16.0.0
56
- - npm >= 7.0.0
57
-
58
- ### Global installation
59
-
60
- ```bash
61
- npm i @bouygues-telecom/staticjs -g
62
- ```
63
-
64
- > 💡 **Tip**: Global installation allows you to use the `create-staticjs-app` command from anywhere on your system.
65
-
66
- ## 📘 Usage
67
-
68
- ### 1. Create a new project
69
-
70
- ```bash
71
- create-staticjs-app
72
- ```
73
-
74
- This command will:
75
-
76
- - 📁 Create the folder structure
77
- - ⚙️ Configure base files
78
- - 📦 Prepare the development environment
79
-
80
- ### 2. Install dependencies
81
-
82
- ```bash
83
- cd your-project
84
- npm i
85
- ```
86
-
87
- ### 3. Build & Start the server
88
-
89
- ```bash
90
- npm run start
91
- ```
92
-
93
- 🎉 **Your project is now accessible at** `http://localhost:3300`
94
-
95
- ## 🔄 Revalidation
96
-
97
- StaticJS offers a unique **targeted revalidation** feature that allows rebuilding specific pages without rebuilding the entire project.
98
-
99
- ### Basic syntax
100
-
101
- ```bash
102
- curl -X POST http://localhost:3000/revalidate \
103
- -H "Content-Type: application/json" \
104
- -d '{ "paths": ["page.tsx"] }'
105
- ```
106
-
107
- ## 📚 Examples
108
-
109
- #### Revalidate a single page
110
-
111
- ```bash
112
- curl -X POST http://localhost:3000/revalidate \
113
- -H "Content-Type: application/json" \
114
- -d '{ "paths": ["home.tsx"] }'
115
- ```
116
-
117
- #### Revalidate multiple pages
118
-
119
- ```bash
120
- curl -X POST http://localhost:3000/revalidate \
121
- -H "Content-Type: application/json" \
122
- -d '{ "paths": ["home.tsx", "about.tsx", "contact.tsx"] }'
123
- ```
124
-
125
- ## ⚙️ Configuration
126
-
127
- ### Project structure
128
-
129
- ```
130
- your-project/
131
- ├── 📁 src/
132
- │ ├── 📁 pages/ # Your pages
133
- │ ├── 📁 components/ # Reusable components
134
- │ ├── 📁 styles/ # Style files
135
- │ └── 📁 utils/ # Utilities
136
- ├── 📁 public/ # Static assets
137
- ├── 📄 package.json
138
- └── 📄 server.js # StaticJS server
139
- ```
140
-
141
- ## 🛠️ Available scripts
142
-
143
- | Script | Description |
144
- | --------------- | -------------------------------- |
145
- | `npm run build` | Build the project for production |
146
- | `npm run start` | Start the production server |
147
-
148
- ## 📄 License
149
-
150
- This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
151
-
152
- ---
153
-
154
- <div align="center">
155
-
156
- **Developed with ❤️ by the Bouygues Telecom team**
157
-
158
- </div>