Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

›Yo Akumina

Akumina

  • Quickstart

Yo Akumina

  • Yo Akumina
  • Start with Yeoman
  • React
  • Simple template

Widget Builder

  • Widget Builder Structure
  • Akumina Widget Builder
  • Skipping instances
  • Token replacement for widget properties

Widget Development Quickstart

  • Setting up the Project
  • Configuring .env file
  • Configuring - akumina.sitedployer.config.json file
  • Configuring - akumina.config.json file
  • Extras

Widget Info

  • Akumina Widgets Overview
  • Building a New Widget Instance
  • Widget Views
  • Widget Properties
  • Global vs Local widgets (Widget Scoping)
  • Akumina React Widgets
  • Callbacks
  • RenderChildWidgets
  • Vendor Package List

Virtual Page Builder

  • Akumina Virtual Page Builder
  • Using Virtual Page Layouts
  • Creating a Custom Layout

Stream Card Builder

  • Installation
  • Stream Card Builder
  • Custom Cards
  • Activity Comments Config
  • Akumina Activity Stream PUSH Subscription using PowerAutomate to connect to ServiceNow
  • Akumina Activity Stream PUSH Subscription using PowerAutomate to connect to Dynamic 365

Site Deployer

  • Overview
  • Version 6.0
  • List Attribute Deployments
  • NPM Commands
  • SPA Updates and Deploying to multiple sites

Authoring

  • Content Action Event
  • Publish Validation Integration
  • Field Event Integration
  • CK Editor external plugins

Headless

  • Quickstart
  • Headless Teams support
  • Headless Troubleshooting

Modern

  • Overview
  • FAQ
  • Single Page Application
  • Modern Web Part Library
  • Google Analytics for Modern Pages

Site Creator

  • Overview
  • Adding A Custom Site Definition
  • Core Step Classes
  • Custom Site Definition Components
  • Custom Site Definition XML
  • Custom Subsite Definitions
  • Sample Step Code
  • Supported Tokens

Azure DevOps

  • CI/CD using Azure DevOps
  • Setting up a build to deploy a site package
  • Setting up a build to deploy file to App Manager hosted in an app service

Configuration

  • Configuration Context Overview
  • Edit the Redis cache timeout
  • Using a key vault for the client id and client secret

Debugging

  • Debugging in Akumina

Advanced

  • Central Site Collection Support
  • Eventing OOB Digital Workplace Events
  • Working with custom JSX Views
  • Page Indexing

Service Hub

  • Quickstart

Patch Notes

  • Patch Notes

React

Akumina sample project - FrontEndReact (with Typescript)

Sample project showing how to use React with Akumina framework.

See MyFirstReactComponent .tsx code

Akumina Widget Builder quick start

Step 1

Update the .env with your SiteDeployer parameters.

Set SiteDeployer options in akumina.sitedeployer.config.json.

Deploy Your Widget

For info on Site Deployer and its usage, visit the README

The following command will read from your webpack.config.js

One command to run them all:

npm run all

Or:

npm run build

To create your widget package (.zip) that will be used by the Site Creator, use the following command (Note this zip file can be uploaded manually into the App Manager tool) - this .zip file will be automatically deployed to the WidgetPackageDestinationPath setting in ./akumina.config.json

npm run package

To initiate the deployment process which will call the Site Deployer use the folling command: (deploy.js is ONLY used by local developer environments, for CI/VSTS usage, please see the following doc Continuous-Site-Package-Deployment)

npm run deploy 

This should have deployed a layout, a page and a sample 'MyFirstReactComponent' Browse to http://{tenant}.sharepoint.com/sites/{sitecolllection}/pages/sandbox.aspx

← Start with YeomanSimple template →
  • Deploy Your Widget
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2024 Akumina