oceanhelm 0.0.1

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.
package/LICENSE ADDED
@@ -0,0 +1,35 @@
1
+ OceanHelm Proprietary License
2
+ Copyright © 2025 OceanHelm by Peppu Ventures Limited
3
+
4
+ All rights reserved.
5
+
6
+ 1. Grant of License
7
+ Subject to the terms below, Peppu Ventures Limited (“Licensor”) grants the Licensee a non-exclusive, non-transferable, revocable license to use the OceanHelm software (“Software”) solely for internal business purposes.
8
+
9
+ 2. Restrictions
10
+ Licensee shall not, without prior written consent from Licensor:
11
+
12
+ Copy, distribute, modify, or create derivative works of the Software.
13
+
14
+ Reverse engineer, decompile, or attempt to extract source code.
15
+
16
+ Rent, lease, sublicense, sell, or otherwise transfer the Software to third parties.
17
+
18
+ Use the Software for any illegal or unauthorized purpose.
19
+
20
+ 3. Ownership
21
+ Licensor retains all intellectual property rights in the Software. This license does not transfer ownership of the Software or its components.
22
+
23
+ 4. Termination
24
+ This license terminates automatically if the Licensee fails to comply with any term herein. Upon termination, Licensee must cease all use and destroy all copies of the Software.
25
+
26
+ 5. Disclaimer of Warranty
27
+ The Software is provided “as is” without warranties of any kind, express or implied, including but not limited to merchantability or fitness for a particular purpose.
28
+
29
+ 6. Limitation of Liability
30
+ In no event shall Licensor be liable for damages, including lost profits or data, arising out of the use or inability to use the Software.
31
+
32
+ 7. Governing Law
33
+ This license shall be governed by the laws of [Your Country/State], without regard to conflict of law provisions.
34
+
35
+ By installing or using OceanHelm, you agree to these terms.
package/README.md ADDED
@@ -0,0 +1,121 @@
1
+ <p align="center">
2
+ <img src="https://drive.google.com/uc?id=1zuFeU6IMcuQOzH_kNWm1IY0G467egD1z" alt="OceanHelm Banner" />
3
+ </p>
4
+
5
+ # 🌊 OceanHelm
6
+
7
+ > **One Software for All Your Maritime Needs**
8
+ OceanHelm is a **highly customizable JavaScript library** designed to streamline maritime operations. From **crew management** to **certification tracking**, **voyage planning**, and **maintenance scheduling**, OceanHelm unifies every critical process into a single cohesive solution — empowering ship owners, operators, and marine engineers to focus on what matters most: **navigating safely and efficiently**.
9
+
10
+ ---
11
+
12
+ ## ✨ Features
13
+
14
+ - **Crew Management**
15
+ Manage onboarding, assignments, and crew rotations effortlessly.
16
+
17
+ - **Certification Tracking**
18
+ Keep all vessel and crew certifications up to date with automated reminders.
19
+
20
+ - **Inventory**
21
+ Track inventory, record low items, report low items.
22
+
23
+ - **Maintenance Scheduling**
24
+ Schedule and track maintenance tasks to maximize vessel uptime.
25
+
26
+ ---
27
+
28
+ ## 📦 Installation
29
+
30
+ ```bash
31
+ npm install oceanhelm
32
+ ```
33
+
34
+ or
35
+
36
+ ```yarn
37
+ yarn add oceanhelm
38
+ ```
39
+
40
+ ### 🚀 Quick Start
41
+ ```ES Module
42
+ <template>
43
+ <DashHead
44
+ :name="name"
45
+ :user-profile="userProfile"
46
+ @add-user="addUser"
47
+ @logged-in="loggedIn"
48
+ />
49
+ </template>
50
+
51
+ <script>
52
+ import { ConfigurableSidebar, VesselList, DashHead, CrewManagement, ActivityLogs, OceanHelmMaintenance } from 'oceanhelm';
53
+
54
+ export default {
55
+ name: 'DashHeader',
56
+
57
+ props: {
58
+ name: String,
59
+ },
60
+
61
+ components: {
62
+ DashHead
63
+ },
64
+
65
+ computed: {},
66
+
67
+ methods: {}
68
+ }
69
+ </script>
70
+ ```
71
+
72
+ ```CommonJS
73
+ <template>
74
+ <DashHead
75
+ :name="name"
76
+ :user-profile="userProfile"
77
+ @add-user="addUser"
78
+ @logged-in="loggedIn"
79
+ />
80
+ </template>
81
+ const { ConfigurableSidebar, VesselList, DashHead, CrewManagement, ActivityLogs, OceanHelmMaintenance } = require('oceanhelm');
82
+
83
+ <script>
84
+ import { DashHead } from 'oceanhelm'
85
+
86
+ export default {
87
+ name: 'DashHeader',
88
+
89
+ props: {
90
+ name: String,
91
+ },
92
+
93
+ components: {
94
+ DashHead
95
+ },
96
+
97
+ computed: {},
98
+
99
+ methods: {}
100
+ }
101
+ </script>
102
+ ```
103
+
104
+ ## 🛠️ API Overview
105
+
106
+ *(Full API documentation coming soon!)*
107
+
108
+ ## 🖼️ UI Styling
109
+ OceanHelm ships with minimal default styles. Import them if needed:
110
+
111
+ ```
112
+ import 'oceanhelm/dist/style.css';
113
+ ```
114
+
115
+ ## 🤝 Contributing
116
+ Contributions are welcome!
117
+ If you’d like to add features, fix bugs, or improve docs, fork the repo and submit a pull request.
118
+
119
+ ## 📜 License
120
+ © 2025 [OcenHelm]. All Rights Reserved.
121
+ OceanHelm is proprietary software. See [LICENSE](./LICENSE) for details.
Binary file