Profile File

The profile file is a yaml file with the following content:

name: "John Doe"
avatar: "<url_to_avatar">
bio: "Just a casual guy"
location: "Chennai"
email: "john_doe@somemail.com"
social_media:
  twitter: "johndoe" # Username
  linkedin: "johndoe" # Username
  github: "johndoe" # Username
  gitlab: "johndoe" # Username

When the avatar field is ignored or left empty, Profile Server falls back to the Gravatar image.

The the base URL i.e., http://localhost:8080/ is hit, it returns the profile information and the navigation information in the following format

{
    "profile": {
        "name": "<name>",
        "avatar": "<avatar_url>",
        "bio": "<bio>",
        "location": "<location>",
        "email": "<email_from_profile_file>",
        "social_media": {
            "twitter": "https://twitter.com/<twitter_username>",
            "linkedin": "https://linkedin.com/in/<linkedin_profile_name>",
            "github": "https://github.com/<github_username>",
            "gitlab": "https://gitlab.com/<gitlab_username>"
        }
    },
    "navigation": {
        "paths": [
            <list_of_paths_from_navigation_file>
        ]
    }
}