Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sanam2405/privacynetwork
Design and Implementation of Security-Conscious, Location-Sharing in a Geosocial Network 🛡️
https://github.com/sanam2405/privacynetwork
borrows-abadi-needham google-maps-api haproxy kafka mern postgis postgres random-oracle redis social-network-analysis typescript websockets
Last synced: about 3 hours ago
JSON representation
Design and Implementation of Security-Conscious, Location-Sharing in a Geosocial Network 🛡️
- Host: GitHub
- URL: https://github.com/sanam2405/privacynetwork
- Owner: sanam2405
- License: apache-2.0
- Created: 2023-09-21T08:54:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T22:53:15.000Z (about 2 months ago)
- Last Synced: 2024-10-30T00:47:56.505Z (about 2 months ago)
- Topics: borrows-abadi-needham, google-maps-api, haproxy, kafka, mern, postgis, postgres, random-oracle, redis, social-network-analysis, typescript, websockets
- Language: TypeScript
- Homepage: https://privacynetwork.sanam.live
- Size: 342 MB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Privacy Network](https://manaspratimbiswas.com/PrivacyNetwork)
Design and Implementation of Security-Conscious,
Location-Sharing in a Geosocial Network
[Link to the Gist](https://manaspratimbiswas.com/PrivacyNetwork)
[Link to the Presentation](papers/Panel_2_Team16_PrivacyNetwork.pptx)
[Link to the Thesis](papers/Design_and_Implementation_of_Security_Conscious__Location_Sharing_in_a_Geosocial_Network.pdf)
[Link to the reference research paper](https://ieeexplore.ieee.org/abstract/document/9288801)
## Architecture
### One Instance Architecture
### Managing the MongoDB and Postgres
### Scalable Architecture
## Privacy Filtration Logic
## Database Schema
### Mongoose Schema
### ERD
### Prisma Schema
## PostGIS Query
```sql
CREATE OR REPLACE FUNCTION nearby_privacy_entities(
IN lat FLOAT,
IN long FLOAT,
IN d FLOAT,
IN max_age FLOAT,
IN college_param TEXT,
IN gender_param TEXT,
IN entity_type TEXT
)
RETURNS TABLE (
id TEXT,
name TEXT,
email TEXT,
age FLOAT,
gender TEXT,
college TEXT,
isVisible BOOLEAN,
lat FLOAT,
long FLOAT,
dist_meters FLOAT
)
LANGUAGE SQL
AS $$
SELECT
entity.id,
entity.name,
entity.email,
entity.age,
entity.gender,
entity.college,
entity."isVisible",
latitude AS lat,
longitude AS long,
ST_DISTANCE(
ST_GeomFromText('POINT(' || long || ' ' || lat || ')', 4326)::geography,
ST_SetSRID(ST_MakePoint(longitude, latitude), 4326)::geography
) AS dist_meters
FROM
"Location"
JOIN
"User" entity ON "Location".id = entity."locationId"
WHERE
ST_DISTANCE(
ST_GeomFromText('POINT(' || long || ' ' || lat || ')', 4326)::geography,
ST_SetSRID(ST_MakePoint(longitude, latitude), 4326)::geography
) <= d AND entity_type = 'user'
AND (college_param IS NULL OR entity.college = college_param)
AND (gender_param IS NULL OR entity.gender = gender_param)
AND (max_age IS NULL OR entity.age <= max_age)
ORDER BY
ST_SetSRID(ST_MakePoint(longitude, latitude), 4326)::geography <-> ST_GeomFromText('POINT(' || long || ' ' || lat || ')', 4326)::geography;
$$;
```
## Privacy Network API Documentation
_[Privacy Network API Docs](https://privacynetwork.onrender.com/docs)_
### OpenAPI Swagger API Docs
__
### OpenAPI Swagger Schemas
__
### Login Page
### Dashboard Page
### Map Page: Real-Time Location Updation
![]()
![]()
### Map Page: Privacy Filtration
### Map Page: Real-Time Location Sharing
## Tech Stack
- TypeScript
- React with _Google Maps API_ and _Material UI_
- Node
- Express
- WebSockets
- MongoDB
- Postgres with PostGIS
- Swagger
## Setting up locally
The codebase is organized as :
1. _ts-frontend_ - The react frontend (_default port 5173_)
2. _backend/ts-backend_ - The primary express backend with mongoDB (_default port 5050_)
3. _backend/loc_ - The secondary express backend with Postgres (_default port 6060_)
4. _backend/ws_ - The websocket backend (_default port 8080_)
- Clone the PrivacyNetwork repository
```bash
git clone [email protected]:sanam2405/PrivacyNetwork.git
cd PrivacyNetwork
```
- Configure the `.env` of the four servers
```bash
// ts-frontend
VITE_BACKEND_URI=
VITE_WS_URI=
VITE_GOOGLE_API_KEY=
```
```bash
// ts-backend
GOOGLE_CLIENT=
GOOGLE_API_KEY=
MONGO_URI=
SECRET_KEY=
PORT=
LOCATION_BACKEND_URI=
BACKEND_INTERCOMMUNICATION_SECRET=
```
```bash
// loc
DATABASE_URL=
DIRECT_URL=
BACKEND_INTERCOMMUNICATION_SECRET=
```
```bash
// ws
SECRET_KEY=
TS_BACKEND_URI=
```
- Database Seeding
```bash
// MongoDB Mock Data
backend/ts-backend/src/mockdata
└── MOCK_DATA.json
// Postgres Mock Data
backend/loc/src/mockdata
├── Location.sql
└── User.sql
```
- Run with docker (_start all services with a single command_)
```bash
docker compose up
```
- Run the frontend
```bash
cd ts-frontend
npm install
npm run dev
```
- Run the MongoDB backend
```bash
cd backend/ts-backend
npm install
npm run dev
```
- Run the Postgres backend
```bash
cd backend/loc
npm install
npm run dev
```
- Run the WebSocket backend
```bash
cd backend/ws
npm install
npm run build
npm start
```
## Contributors
- `Manas Pratim Biswas` -
[LinkedIn](https://www.linkedin.com/in/manas-pratim-biswas/)
- `Anumoy Nandy` -
[LinkedIn](https://www.linkedin.com/in/anumoy-nandy-9b527b204/)
- `Kunal Pramanick` -
[LinkedIn](https://www.linkedin.com/in/kunal-pramanick-9755061b0/)
## Mentor
- `Dr. Munmun Bhattacharya`