README.md 1.24 KB
Newer Older
Corentin Mors's avatar
Corentin Mors committed
1 2
# onMap

3 4
A cross-platform instant and secure location sharing and chat.

Corentin Mors's avatar
Corentin Mors committed
5
![onMap over device](./server/public/img/onmap-header.png)
6 7 8

## About this project

Corentin Mors's avatar
Corentin Mors committed
9 10
onMap aims to let users share their location safely with their friends.

11 12
Websockets are used to instantly share locations between users, data is encrypted with AES using SHA-256 keys and random IV.

Corentin Mors's avatar
Corentin Mors committed
13

14 15 16 17 18 19
## How to use

You may test our running live server at [onMap PixelSwap Instance](https://onmap.pixelswap.fr/)

User chose a room, a username and a password. Anyone can join a room, but if you don't have the same password, you won't understand the others.

Corentin Mors's avatar
Corentin Mors committed
20
> Passwords are never sent to the server !
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42


## Server and clients

Each server and client has its own readme, please refer to them :
- [Server and Web Client](server/README.md)
- [Android Client](android-client/README.md)


## Contributing

Feel free to contribute to this project, fork and pull request your ideas.
Don't include work that is not free, open source or not from you.

You may also run your own instance of onMap on your server !


## Authors

| [![twitter/mikescops](https://avatars0.githubusercontent.com/u/4266283?s=100&v=4)](http://twitter.com/mikescops "Follow @mikescops on Twitter") |
|---|
| [Corentin Mors](https://pixelswap.fr/) |