brilliantsole 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Zack Qattan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# BrilliantSole.js
+
+Web SDK for BrilliantSole insoles
+
+## Running the Node.js server for WebSocket/UDP stuff
+
+On macOS:  
+for the security stuff, run the command in the terminal:  
+`sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ./sec/key.pem -out ./sec/cert.pem`
+Windows is the same but without `sudo`, if you have openssl installed
+
+install https://code.visualstudio.com/ & https://nodejs.org/en/  
+install npm in terminal: sudo npm install  
+install yarn in VS Code terminal: yarn install  
+start localhost: yarn start (try sudo yarn start if that doesn't work)  
+open https://localhost/ in chrome
+
+if it doesn't work, try turning the firewall off
+
+if you have issues saving or running stuff on mac, try:  
+`sudo chown -R username directory_name`