north-star / commit
updated readme and index now points to repo
readme.md | 35 +++++++++++++++++++++++++++++++++-- src/index.html | 2 +- 2 files changed, 34 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index bc7696d..10d8f1e 100644 --- a/readme.md +++ b/readme.md @@ -1,9 +1,40 @@ # North Star +## What is it? + +North Star is a web application that allows users to share their location in real-time with others in the same "room". It provides a simple interface to see where everyone is relative to themselves. + +## How to use it? + +1. Open the application in your browser. +2. You're in a room now. +3. Share the room link with your friends. +4. Everyone who joins the room will be able to see each other's location on the map. +5. Everyone can set a custom name and color for their marker. +6. The app has a control panel where you can disable participants and click on a participant's name to open their location in Google Maps. + +## How does it work? + +The app uses Firebase Realtime Database to store and sync the location data of all participants in real-time. When a user joins a room, they are added to the database with their location and other information. The app listens for changes in the database and updates the map accordingly. + +## Is it secure? + +The app does not require any authentication, so anyone with the room link can join and see the location of all participants. However, the app does not store any personal information and only uses the location data for real-time sharing. The data is stored in Firebase Realtime Database, which has security rules to prevent unauthorized access, so only people in a given room can access the data about that room. + +It's important to share the room link only with trusted individuals to ensure your privacy. + +## Is it open source? + +You're looking at it. + +### License + +This project is licensed under the MIT License. + ## Links Repo: https://gitlab.com/PavelSafronov/north-star -GitLab: https://pavelsafronov.gitlab.io/north-star/#room=7c49d0a8 +GitLab test room: https://pavelsafronov.gitlab.io/north-star/#room=7c49d0a8 -Local: http://127.0.0.1:5500/src/index.html#room=7c49d0a8 +Local test room: http://127.0.0.1:5500/src/index.html#room=7c49d0a8 diff --git a/src/index.html b/src/index.html index e7b3fe2..54861a6 100644 --- a/src/index.html +++ b/src/index.html @@ -10,7 +10,7 @@ </head> <body> - <p class="app-title"><a href="https://pavelsafronov.gitlab.io/north-star/">North Star</a></p> + <p class="app-title"><a href="https://gitlab.com/PavelSafronov/north-star">North Star</a></p> <p id="room-current" class="room-current"></p> <p class="room-links"> <a id="invite-room-link" href="#">Invite to Room</a>