How to contribute

Sebastian · July 15, 2020, 7:27pm

If you like to improve Squidex, here are a set of tasks that need to be implemented.

Documentation is most important, but I know that it is very boring. Therefore a list of tasks:

1. Rule extensions

Write a rule extension for an external system. Examples:

Create a facebook post
Send an event to amazon queue
Invoke serverless functions
Trigger build in various build servers.
Check out contful marketplace for more ideas.

The basic concept for rule actions is described here: https://docs.squidex.io/02-documentation/concepts/rules

You can also have a look to existing rule actions: https://github.com/Squidex/squidex/blob/master/backend/extensions/Squidex.Extensions/Actions/Algolia/AlgoliaAction.cs

2. Use machine learning to tag assets

There are plenty of services out there which could help with this. There is already an existing interface which can be implemente for the tagging process:

github.com

Squidex/squidex/blob/master/backend/src/Squidex.Domain.Apps.Entities/Assets/IAssetMetadataSource.cs

// ==========================================================================
//  Squidex Headless CMS
// ==========================================================================
//  Copyright (c) Squidex UG (haftungsbeschraenkt)
//  All rights reserved. Licensed under the MIT license.
// ==========================================================================

using System.Collections.Generic;
using System.Threading.Tasks;
using Squidex.Domain.Apps.Entities.Assets.Commands;

namespace Squidex.Domain.Apps.Entities.Assets
{
    public interface IAssetMetadataSource
    {
        Task EnhanceAsync(UploadAssetCommand command, HashSet<string>? tags);

        IEnumerable<string> Format(IAssetEntity asset);
    }
}

The tagging for images can be found here:

github.com

Squidex/squidex/blob/master/backend/src/Squidex.Domain.Apps.Entities/Assets/ImageAssetMetadataSource.cs

// ==========================================================================
//  Squidex Headless CMS
// ==========================================================================
//  Copyright (c) Squidex UG (haftungsbeschraenkt)
//  All rights reserved. Licensed under the MIT license.
// ==========================================================================

using System.Collections.Generic;
using System.Threading.Tasks;
using Squidex.Domain.Apps.Core.Assets;
using Squidex.Domain.Apps.Entities.Assets.Commands;
using Squidex.Infrastructure;
using Squidex.Infrastructure.Assets;

namespace Squidex.Domain.Apps.Entities.Assets
{
    public sealed class ImageAssetMetadataSource : IAssetMetadataSource
    {
        private readonly IAssetThumbnailGenerator assetThumbnailGenerator;

This file has been truncated. show original

3. Local time for date time editor in UI

The current datetime editor in the UI shows the UTC dates, which might be confusing. It would be great if the editor can be improved to have a toogle or so to switch from one mode to another.

The editor code:

github.com

Squidex/squidex/blob/master/frontend/app/framework/angular/forms/editors/date-time-editor.component.ts

/*
 * Squidex Headless CMS
 *
 * @license
 * Copyright (c) Squidex UG (haftungsbeschränkt). All rights reserved.
 */

import { AfterViewInit, ChangeDetectionStrategy, ChangeDetectorRef, Component, ElementRef, forwardRef, Input, OnInit, ViewChild } from '@angular/core';
import { FormControl, NG_VALUE_ACCESSOR } from '@angular/forms';
import { DateHelper, DateTime, StatefulControlComponent, UIOptions } from '@app/framework/internal';
import * as Pikaday from 'pikaday/pikaday';
import { FocusComponent } from './../forms-helper';

declare module 'pikaday/pikaday';

export const SQX_DATE_TIME_EDITOR_CONTROL_VALUE_ACCESSOR: any = {
    provide: NG_VALUE_ACCESSOR, useExisting: forwardRef(() => DateTimeEditorComponent), multi: true
};

const NO_EMIT = { emitEvent: false };

This file has been truncated. show original

3. Cloud integrations

If you are an expert for one of the big cloud providers (AWS, GKE, Azure …) it would be great if you can provide a ready to use template to install Squidex within the cloud.

If you are interested in one of these tasks, give me a note and create your own topic for this task. Other ideas are very welcome as well.

Sebastian · July 15, 2020, 7:27pm