Projects

Assets

Assets will be use to populate the UI

Required assets:

• assets/img/app_icon.webp

Folder Structure for a project

projects/your_project
├── assets/img/screenshots/screenshot_1.webp
├── assets/img/app_icon.webp
├── assets/img/banner.webp
├── info.json

The easiest to get the right images is use the public images from the playstore.

Json Documentation

This JSON object is structured as follows:

Example

{
    "name": "My App",
    "description": "This is an awesome company!",
    "publisher": "My Company",
    "developers": [
        {
            "githubUserName": "johndoe",
            "companyName": "companyName",
        }
    ],
    "releaseData": "2023-01-01",
    "links": {
        "appstore": "https://appstore.com/myapp",
        "playstore": "https://playstore.com/myapp",
        "webApp": "https://my.myapp.com",
        "marketingWebsite": "https://myapp.com",
        "youTube": "https://youtube.com/myapp",
        "demoYouTubeVideo": "https://youtube.com/myappdemo"
    }
}

Properties

name

• Data type: string
• Description: Represents the name of the application.
• Constraints: None.

description

• Data type: string
• Description: Represents a brief description of the application.
• Constraints: None.

publisher

• Data type: string
• Description: Represents the publisher of the application. (Should be a company that is added to the companies folder)
• Constraints: None.

developers

• Data type: array
• Description: Represents the developers of the application.
• Constraints: None.

githubUserName

• Data type: string
• Description: Represents the GitHub username of the developer.
• Constraints: None.

comapanyName

• Data type: string or null
• Description: Represents the company the developer was working for. (If it is the same as the publisher, no need to set this one)
• Constraints: None.

releaseData

• Data type: string
• Description: Represents the release date of the application.
• Constraints: None.

links

• Data type: object
• Description: Represents a collection of links related to the application.
• Constraints: None.

appstore

• Data type: string or null
• Description: Represents the link to the application's listing on the Apple App Store or null if not available.
• Constraints: None.

playstore

• Data type: string or null
• Description: Represents the link to the application's listing on the Google Play Store or null if not available.
• Constraints: None.

webApp

• Data type: string or null
• Description: Represents the link to the application's website or null if not available.
• Constraints: None.

marketingWebsite

• Data type: string or null
• Description: Represents the link to the application's marketing website or null if not available.
• Constraints: None.

youTube

• Data type: string or null
• Description: Represents the link to the application's YouTube page or null if not available.
• Constraints: None.

demoYouTubeVideo

• Data type: string or null
• Description: Represents the link to a demo video of the application on YouTube or null if not available.
• Constraints: None.