@fastybird/smart-panel 0.1.0-alpha.5

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 (42) hide show
  1. package/README.md +98 -0
  2. package/bin/smart-panel-service.js +1074 -0
  3. package/bin/smart-panel.js +43 -0
  4. package/dist/index.d.ts +6 -0
  5. package/dist/index.d.ts.map +1 -0
  6. package/dist/index.js +6 -0
  7. package/dist/index.js.map +1 -0
  8. package/dist/installers/base.d.ts +78 -0
  9. package/dist/installers/base.d.ts.map +1 -0
  10. package/dist/installers/base.js +5 -0
  11. package/dist/installers/base.js.map +1 -0
  12. package/dist/installers/index.d.ts +8 -0
  13. package/dist/installers/index.d.ts.map +1 -0
  14. package/dist/installers/index.js +16 -0
  15. package/dist/installers/index.js.map +1 -0
  16. package/dist/installers/linux.d.ts +32 -0
  17. package/dist/installers/linux.d.ts.map +1 -0
  18. package/dist/installers/linux.js +406 -0
  19. package/dist/installers/linux.js.map +1 -0
  20. package/dist/utils/index.d.ts +5 -0
  21. package/dist/utils/index.d.ts.map +1 -0
  22. package/dist/utils/index.js +5 -0
  23. package/dist/utils/index.js.map +1 -0
  24. package/dist/utils/logger.d.ts +17 -0
  25. package/dist/utils/logger.d.ts.map +1 -0
  26. package/dist/utils/logger.js +55 -0
  27. package/dist/utils/logger.js.map +1 -0
  28. package/dist/utils/paths.d.ts +26 -0
  29. package/dist/utils/paths.d.ts.map +1 -0
  30. package/dist/utils/paths.js +57 -0
  31. package/dist/utils/paths.js.map +1 -0
  32. package/dist/utils/system.d.ts +87 -0
  33. package/dist/utils/system.d.ts.map +1 -0
  34. package/dist/utils/system.js +211 -0
  35. package/dist/utils/system.js.map +1 -0
  36. package/dist/utils/version.d.ts +11 -0
  37. package/dist/utils/version.d.ts.map +1 -0
  38. package/dist/utils/version.js +75 -0
  39. package/dist/utils/version.js.map +1 -0
  40. package/package.json +72 -0
  41. package/templates/environment.template +28 -0
  42. package/templates/systemd/smart-panel.service +31 -0
package/README.md ADDED
@@ -0,0 +1,98 @@
1
+ # @fastybird/smart-panel
2
+
3
+ FastyBird Smart Panel - IoT Dashboard for Linux devices including Raspberry Pi.
4
+
5
+ ## Quick Start
6
+
7
+ ```bash
8
+ # Install globally
9
+ sudo npm install -g @fastybird/smart-panel
10
+
11
+ # Install and start as a service
12
+ sudo smart-panel-service install
13
+
14
+ # Open http://localhost:3000 in your browser
15
+ ```
16
+
17
+ ## Installation Options
18
+
19
+ ```bash
20
+ # Custom port with admin user
21
+ sudo smart-panel-service install \
22
+ --port 8080 \
23
+ --admin-username admin \
24
+ --admin-password yourpassword
25
+
26
+ # View all options
27
+ smart-panel-service install --help
28
+ ```
29
+
30
+ ## Service Management
31
+
32
+ ```bash
33
+ # Check status
34
+ sudo smart-panel-service status
35
+
36
+ # View logs
37
+ sudo smart-panel-service logs -f
38
+
39
+ # Restart
40
+ sudo smart-panel-service restart
41
+
42
+ # Update
43
+ sudo smart-panel-service update
44
+
45
+ # Uninstall
46
+ sudo smart-panel-service uninstall
47
+ ```
48
+
49
+ ## CLI Commands
50
+
51
+ ### smart-panel-service
52
+
53
+ | Command | Description |
54
+ |---------|-------------|
55
+ | `install` | Install as systemd service |
56
+ | `uninstall` | Remove the service |
57
+ | `start` | Start the service |
58
+ | `stop` | Stop the service |
59
+ | `restart` | Restart the service |
60
+ | `status` | Show service status |
61
+ | `logs` | View service logs |
62
+ | `update` | Update to latest version |
63
+
64
+ ### smart-panel
65
+
66
+ Access backend CLI commands:
67
+
68
+ ```bash
69
+ # Create admin user
70
+ sudo smart-panel auth:onboarding <username> <password>
71
+
72
+ # List users
73
+ sudo smart-panel users:list
74
+
75
+ # Run database migrations
76
+ sudo smart-panel migration:run
77
+ ```
78
+
79
+ ## Requirements
80
+
81
+ - Linux with systemd
82
+ - Node.js 24+
83
+ - ARM, ARM64, or x64 architecture
84
+
85
+ ## Documentation
86
+
87
+ See [docs/INSTALLATION.md](docs/INSTALLATION.md) for detailed installation instructions.
88
+
89
+ ## Links
90
+
91
+ - **Website**: https://smart-panel.fastybird.com
92
+ - **Documentation**: https://smart-panel.fastybird.com/docs
93
+ - **GitHub**: https://github.com/FastyBird/smart-panel
94
+ - **Issues**: https://github.com/FastyBird/smart-panel/issues
95
+
96
+ ## License
97
+
98
+ Apache-2.0