Companies

Assets

Assets will be use to populate the UI

Required assets:

• assets/img/logo.webp

Folder Structure for a company

companies/your_company_name
├── assets/img/logo.webp
├── (assets/img/logo.svg)
├── info.json

Json Documentation

This JSON object is structured as follows:

Example

{
    "name": "Example Company",
    "description": "This is an example company description.",
    "useLogoInsteadOfTextTitle": false,
    "links": {
        "website": "https://example-company.com",
        "jobWebsite": "https://example-company.com/jobs"
    }
}

Agency Support

As you can see, there is no option to set that you are an agency. Right now we detect that the company is an agency if developers worked on a project that the company itself did not publish. (set companyName in the developer list of a project, to indicate that the company worked on that project) Checkout the documentation here

Properties

name

• Data type: string (required)
• Description: Represents the name of the company.
• Constraints: This should be precisely the same as its parent folder.

description

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

useLogoInsteadOfTextTitle

• Data type: boolean (optional)
• Description: If set to true, the company logo will be used as the title instead of text.
• Constraints: None.
• Default: false

links

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

website

• Data type: string (optional)
• Description: Represents the marketing website of the company
• Constraints: Should start with https://
• Default: null

jobWebsite

• Data type: string (optional)
• Description: Represents the job website of the company
• Constraints: Should start with https://
• Default: null