Skip to content

Initial notes, scope and architecture #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Initial notes, scope and architecture #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
# EP Map

#### A simple visualization of all EPs and SPs locations on the map.




Initial notes, scope and architecture proposal:

# Scope
- A map for the EP locations with their profile picture from LinkedIn profile
- Access/Security with a list of emails
- DB will be updated with manual execution of scripts

# Use cases
- Login with a textbox to capture the email,
(V2: a token will be send to the email if the email is present on the allowed access list)
- Map with all the EP listed - no filters

# Routes
- login - Routes to request and validate a login token to setup a session cookie
- list - list of EP with location details and profile picture

# Architecture
- React with App Playground
- Backend GO(Node typescript) REST routes with App Playground
- Postgres DB with spatial extension

# Utils
- Script to parse and insert the gsheet CSV into the database
- Script to generate the database location from a province, contry pair and update the database
- Script to get information from the EP LinkedIn profile