Samples
Overview
Samples are preconfigured application components (entities, associations, navigation, screens, and application objects) that can be added to a project to quickly and easily add specific features. Samples can also be added to a brand new project to fast track creation.
Samples offer a number of benefits, including:
Speed: Samples can save you a significant amount of time and effort by providing you with pre-built components that you can simply add to your project.
Quality: Samples are developed by experienced developers and are tested to ensure that they meet high quality standards.
Flexibility: Samples can be customised to meet your specific needs.
Types of Samples
The platform supports the following types of samples:
Item samples: These samples add a single feature to a project, such as Governance, Live Chat, or Base Temporal Entity.
Group samples: These complex samples are used to create fully fledged applications with multiple features, such as Blog, Smart City, or Business Directory. A group sample is a set of item samples.
Adding and removing samples in a ComUnity Project
Samples may have dependencies, which are references to other samples. When you add a sample with dependencies to your project, the Toolkit will automatically add its dependencies to the project. Conversely, when you remove a sample with dependencies, its dependencies are not removed from your project.
To add a sample to a new project
Create a new project and add the relevant sample on initial set up.
After successfully creating your project, you can navigate to Project Settings > Samples to manage samples.
To add a sample to an existing project
Go to Project Settings > Samples.
All the samples that are already included in your project will have their checkboxes ticked.
Select a sample by ticking its checkbox. Conversely, you may deselect a sample by unticking its checkbox.
Click Save.
More details about the samples that are supported in the ComUnity Development Toolkit:
Application components (entities, associations, navigation, screens, and application objects) typically have preconfigured permission rules that control user access view Authorisation learn more.
Supported Samples
The ComUnity Development Toolkit includes a variety of supported samples that can be used to quickly and easily add features to your project. Samples are preconfigured application components (entities, associations, navigation, screens, and application objects) that are developed by experienced developers and tested to ensure high quality standards.
Using supported samples can save you a significant amount of time and effort, and can help you to create better quality applications. Samples are also flexible and can be customized to meet your specific needs.
In this subsection, we will list all of the supported samples that are available in the ComUnity Development Toolkit. We will also provide a brief description of each sample and explain how to use it.
We encourage you to browse the list of supported samples and to use them to create your own custom applications. If you have any questions or need assistance, please do not hesitate to contact our support team.
Application Sharing
The Application Sharing sample adds application components which allow users to share your app though SMS invitation. The Notifications sample is a dependency of the ApplicationSharing sample.
Base Temporal Entity
The BaseTemporalEntity in the ComUnity Platform is a no-code template for working with temporal tables. It is recommended that temporal entities inherit from the BaseTemporalEntity.
Communities
The Communities sample adds application components which allow admins to manage community data. The Notifications sample is a dependency of the Communities sample.
Economic Development
The Economic Development sample provides a comprehensive solution for municipalities to manage economic development efforts in their communities. This template allows businesses to create and manage their listings, while also allowing municipal administrators to send business invitations and other notifications.
The Economic Development template includes dependencies on several other samples, including Communities, Notifications, and Push Notifications. These dependencies provide additional functionality and customisation options, such as targeted notifications to specific user groups and real-time updates for users.
With the Economic Development template, municipalities can streamline their economic development efforts and provide a user-friendly platform for businesses to manage their listings and connect with the community. This can help to boost local economic growth and promote a thriving business environment. Contact Us
This sample adds application components which allow admins to add contact us numbers and also allows both users and admins to view contact us numbers.
Fault Log
The Fault Log sample is a logger implementation that allows community members to report faults or issues encountered while using municipal services. Municipal administrators can manage and address submitted logs, view and prioritise them, and track issue resolution progress. Notifications is a dependency of the Fault Log sample. Feedback
This sample adds application components which allow users to post feedback and also allows admins to view feedback logs. Governance
The Governance sample includes application components that enable local governments to publish their documents and procedures for public consumption. Although it was initially designed for municipalities, its generic document publishing capabilities can be adapted to fit other use cases. LiveChat
The Live Chat sample provides a generic solution for offering real-time communication with users of digital services, whether it be a website or a mobile application. With the Live Chat feature, users can chat directly with customer service representatives or support agents to get quick answers to their questions, report issues, or provide feedback. NewsFeed The NewFeed sample adds application components which allow admins to post and edit news articles and also allows users to view news articles. Notifications
The Notification sample enables an application to send both personal and broadcast notifications. Personal notifications can be targeted to a specific user while broadcast notifications are sent to all users of the application. These types of notifications primarily fall under the IN APP channels in the Communication Services and must be configured programmatically, to learn more view Trigger the Communication Service. Additionally, the Community sample includes Community Notifications, which can be used to send notifications to a specific community within the application. PublicSafety
The PublicSafety sample adds application components which allow admins to manage public safety and also allows users to view vacancies and manage their cvs and job applications. The Notifications and PushNotifications samples are dependencies of the PublicSafety sample. Terms
The Terms sample adds a page in your application that outlines the terms and conditions of using applications built on the ComUnity Platform, this page is accessible to all of your users. Twitter
The Twitter sample allows you to add a Twitter feed to your application using a specified hashtag or Twitter handle. However, currently there is no UI available in the toolkit the configuration of the Twitter feed. You can contact our technical team for assistance in setting up the Twitter feed in your application. Vacancies
The Vacancies sample adds application components which allow admins to manage vacancies also allows users to view vacancies and manage their cvs and job applications. Youth Development
The YouthDevelopment sample adds application components which allow admins to post and edit youth opportunities and also allows both admins and users to view youth opportunities. Blog
A Blog sample is a pre-built template or functionality that can be used to add a blog section to an application or website. It typically includes features such as the ability to create, edit and publish blog articles and manage comments. Business Directory
The Bussiness Directory sample provides functionality to add the business profile to your applications, profile properties which can be added include photo, address, geo-location and photo. Smart City
The SmartCity sample is a complex sample which includes the ApplicationSharing, BaseTemporalEntity, Communities, ContactUs, EconomicDevelopment, FaultLog, Feedback, Governance, LiveChat, NewsFeed, Notifications, PublicSafety, PushNotifications, Terms, Twitter, Vacancies and YouthDevelopment samples. It is used as a template to build smart cities.
Surveys
The Survey sample provides a flexible way to create and conduct surveys within an application. Users can define custom survey questions using a variety of question types, such as multiple choice, rating scales, and open-ended text fields. These questions can be arranged into a survey form that can be filled out by respondents within the application. Once the survey is complete, the responses can be collected and analysed by the application administrators.
Last updated
