Skip to content

Commit

Permalink
chore: add integrations (#28)
Browse files Browse the repository at this point in the history
  • Loading branch information
MatejVukosav authored Sep 19, 2024
1 parent fc89fb1 commit dbc383e
Show file tree
Hide file tree
Showing 9 changed files with 142 additions and 75 deletions.
Empty file modified .husky/pre-commit
100644 → 100755
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ Application Details from Applications section of the Admin Dashboard.

![Application details](/admin-dashboard/application-details-for-context-creation.png)

`contractApplicationId` is the id of application stored in the contract. Value is
optional but if provided, it enables Admin Dashboard to extract and display the
application metadata.
`contractApplicationId` is the id of application stored in the contract. Value
is optional but if provided, it enables Admin Dashboard to extract and display
the application metadata.

```bash title="Example"
cargo run -p meroctl -- --node-name node1 --home data \
Expand Down
15 changes: 15 additions & 0 deletions docs/07-integrations/01-extendability.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: extendability
title: Extendability
---

# Extending the Calimero Protocol with Custom Integrations

The Calimero protocol is designed with flexibility in mind, allowing it to
seamlessly extend its core capabilities. By utilizing its modular architecture,
a wide range of integrations can be supported, making it adaptable to a variety
of use cases. Whether the need arises to communicate with external systems or
enhance existing functionalities, the protocol's extensibility ensures that new
components can be integrated with minimal friction. This design empowers
developers to connect the protocol to external services, networks, or
mechanisms, unlocking even more value and versatility.
15 changes: 15 additions & 0 deletions docs/07-integrations/02-blockchains/01-near-integration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: near-integration
title: NEAR Integration
---

# NEAR Protocol Integration

Calimero offers integration with the NEAR Protocol, allowing users to
authenticate using their NEAR accounts. This integration provides access to
essential blockchain functionalities, enabling users to read data directly from
the NEAR blockchain and perform write operations securely.

Whether interacting with decentralized applications or managing on-chain assets,
this integration ensures a smooth and efficient user experience while leveraging
the power of NEAR.
13 changes: 13 additions & 0 deletions docs/07-integrations/02-blockchains/02-starknet-integration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: starknet-integration
title: Starknet Integration
---

# Starknet Integration

Calimero is in the process of integrating with Starknet, which will soon allow
users to interact with the Starknet ecosystem. This integration will enable
authentication, data reading, and writing on Starknet, opening up opportunities
for leveraging its scalability and zero-knowledge technology. As this feature
develops, users will be able to integrate Starknet’s capabilities into their
workflows.
13 changes: 13 additions & 0 deletions docs/07-integrations/02-blockchains/03-icp-integration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
id: icp-integration
title: ICP Integration
---

# Internet Computer Protocol Integration

Calimero’s integration with the Internet Computer Protocol (ICP) is underway,
aiming to connect users with the decentralized services offered by ICP. Once
complete, users will be able to authenticate and interact with data on the ICP
network, facilitating communication with a highly scalable and decentralized
infrastructure. The upcoming integration will provide even greater flexibility
for developers and users to build on and connect to ICP.
3 changes: 3 additions & 0 deletions docs/07-integrations/02-blockchains/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Blockchains"
}
3 changes: 3 additions & 0 deletions docs/07-integrations/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"label": "Integrations"
}
149 changes: 77 additions & 72 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -1,63 +1,63 @@
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import { themes as prismThemes } from 'prism-react-renderer';

const config: Config = {
title: "Calimero 2.0",
title: 'Calimero 2.0',
tagline:
"Calimero Network is a framework which enables building fully decentralized applications, ensuring everyone's data privacy.",
favicon: "img/favicon.ico",
url: "https://calimero-network.github.io",
baseUrl: "/",
organizationName: "calimero-network",
projectName: "calimero-2.0",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
favicon: 'img/favicon.ico',
url: 'https://calimero-network.github.io',
baseUrl: '/',
organizationName: 'calimero-network',
projectName: 'calimero-2.0',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
i18n: {
defaultLocale: "en",
locales: ["en"],
defaultLocale: 'en',
locales: ['en'],
},
headTags: [
{
tagName: "script",
tagName: 'script',
attributes: {
"data-collect-dnt": "true",
src: "https://scripts.simpleanalyticscdn.com/latest.js",
async: "async",
defer: "defer",
'data-collect-dnt': 'true',
src: 'https://scripts.simpleanalyticscdn.com/latest.js',
async: 'async',
defer: 'defer',
},
},
],
presets: [
[
"classic",
'classic',
{
docs: {
sidebarPath: "./sidebars.ts",
routeBasePath: "/", // Serve the docs at the site's root
sidebarPath: './sidebars.ts',
routeBasePath: '/', // Serve the docs at the site's root
breadcrumbs: true,
showLastUpdateTime: true,
},
blog: false,
theme: {
customCss: "./src/css/custom.scss",
customCss: './src/css/custom.scss',
},
} satisfies Preset.Options,
],
],
plugins: ["docusaurus-plugin-sass"],
plugins: ['docusaurus-plugin-sass'],
themeConfig: {
colorMode: {
disableSwitch: false,
defaultMode: "dark",
defaultMode: 'dark',
respectPrefersColorScheme: true,
},
announcementBar: {
id: "id-0002",
id: 'id-0002',
content:
'**🎉 Come check <a href="https://www.calimero.network/">our new website</a> 🎉**',
backgroundColor: "#247E80",
textColor: "#fff",
backgroundColor: '#247E80',
textColor: '#fff',
isCloseable: true,
},
docs: {
Expand All @@ -66,90 +66,95 @@ const config: Config = {
},
},
navbar: {
style: "dark",
style: 'dark',
logo: {
alt: "Calimero Network",
src: "img/logo.svg",
alt: 'Calimero Network',
src: 'img/logo.svg',
},
items: [
{
to: "/explore/intro",
position: "left",
label: "Explore",
to: '/explore/intro',
position: 'left',
label: 'Explore',
},
{
to: "/learn/architecture",
position: "left",
label: "Learn",
to: '/learn/architecture',
position: 'left',
label: 'Learn',
},
{
to: "/build/quickstart",
position: "left",
label: "Build",
to: '/build/quickstart',
position: 'left',
label: 'Build',
},
{
to: "/contribute/github",
position: "left",
label: "Contribute",
to: '/contribute/github',
position: 'left',
label: 'Contribute',
},
{
to: "/resources/community-and-support",
position: "left",
label: "Resources",
to: '/resources/community-and-support',
position: 'left',
label: 'Resources',
},
{
to: "/getting-started/setup",
position: "right",
label: "Getting started",
to: '/integrations/extendability',
position: 'left',
label: 'Integrations',
},
{
type: "search",
position: "right",
to: '/getting-started/setup',
position: 'right',
label: 'Getting started',
},
{
href: "https://github.com/calimero-network/core",
label: "GitHub",
position: "right",
type: 'search',
position: 'right',
},
{
href: 'https://github.com/calimero-network/core',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: "dark",
style: 'dark',
copyright: `Copyright © ${new Date().getFullYear()} Calimero Limited LLC.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
additionalLanguages: ["bash", "toml"],
additionalLanguages: ['bash', 'toml'],
},
algolia: {
// The application ID provided by Algolia
appId: "W1H5P6IW4T",
appId: 'W1H5P6IW4T',
// Public API key: it is safe to commit it
apiKey: "f18239c312d6cc30d128a382d330278d",
indexName: "calimero-networkio",
apiKey: 'f18239c312d6cc30d128a382d330278d',
indexName: 'calimero-networkio',
// Optional: see doc section below
contextualSearch: true,
searchPagePath: "search",
searchPagePath: 'search',
// Optional: Algolia search parameters
searchParameters: {
clickAnalytics: true,
analytics: true,
enableReRanking: true,
attributesToRetrieve: [
"hierarchy.lvl0",
"hierarchy.lvl1",
"hierarchy.lvl2",
"hierarchy.lvl3",
"hierarchy.lvl4",
"hierarchy.lvl5",
"hierarchy.lvl6",
"type",
"url",
"title",
"description",
"headers",
"headersLevels",
'hierarchy.lvl0',
'hierarchy.lvl1',
'hierarchy.lvl2',
'hierarchy.lvl3',
'hierarchy.lvl4',
'hierarchy.lvl5',
'hierarchy.lvl6',
'type',
'url',
'title',
'description',
'headers',
'headersLevels',
],
},
//... other Algolia params
Expand Down

0 comments on commit dbc383e

Please sign in to comment.