Developers

Project Documentation

Assets

Assets will be use to populate the UI

No Required assets

Folder Structure for a project

developers/your_github_username
├── info.json

JSON Documentation

This JSON object is structured as follows:

Example

{
    "githubUserName": "my-github-user-name",
    "name": "My Full Name",
    "description": "This is a description of myself",
    "links": {
        "linkedin": "https://linkedin.com/in/my-linkedin-handle",
        "personalWebsite": "https://my-website.com",
        "freelanceWebsite": "https://my-freelance-website.com",
    }
}

Properties

githubUserName

• Data type: string (required)
• Description: Represents the GitHub username of the developer. It can be found in the URL of the developer's GitHub account.
• Constraints: This should be a real githubUserName. A check will be done if it is valid. And the profile picture will be used from GitHub

name

• Data type: string (optional)
• Description: Represents the full name of the developer.
• Constraints: None.
• Default: null

description

• Data type: string (optional)
• Description: Represents a description of the developer.
• Constraints: None.
• Default: null

links

• Data type: object (optional)
• Description: Represents all links related to the developer.
• Constraints: None.
• Default: null

linkedin

• Data type: string (optional)
• Description: Represents the link to the developer's LinkedIn. (Should start with https://linkedin.com/in/ or https://www.linkedin.com/in/)
• Constraints: None.
• Default: null

personalWebsite

• Data type: string (optional)
• Description: Represents the link to the developer's personal website.
• Constraints: None.
• Default: null

freelanceWebsite

• Data type: string (optional)
• Description: Represents the link to the developer's freelance website.
• Constraints: None.
• Default: null