Skip to content

Commit

Permalink
docs: apps SDK notes (#145)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrii-bodnar authored Oct 3, 2024
1 parent f6eef23 commit 113adb4
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tableOfContents: false
---

import { Image } from 'astro:assets';
import { LinkCard, CardGrid, Card } from '@astrojs/starlight/components';
import { LinkCard, CardGrid, Card, Aside } from '@astrojs/starlight/components';
import ReadMore from '~/components/ReadMore.astro';
import HelpBanner from '~/components/HelpBanner.astro';
import developerHero from '~/assets/images/developer-portal-hero.png';
Expand Down Expand Up @@ -67,6 +67,10 @@ The next step would be to implement the app functionality according to the app d
Read more about [UI Modules](/developer/crowdin-apps-modules-ui/) and [File Processing Modules](/developer/crowdin-apps-modules-file-processing/).
</ReadMore>

<Aside type="tip" title="Interested in developing Crowdin Apps?">
[Contact Us](https://crowdin.com/contacts) to get exclusive access to the Crowdin Apps SDK, which allows you to create apps in just a few lines of code.
</Aside>

## Using Crowdin APIs in Crowdin Apps

Crowdin Apps communicate with Crowdin using our RESTful APIs. You can use the Crowdin APIs in Crowdin apps you develop for Crowdin, as well as in scripts, API clients, or other methods of making calls.
Expand Down
4 changes: 4 additions & 0 deletions src/content/docs/developer/crowdin-apps/app-descriptor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ The app descriptor is one of the essential building blocks of Crowdin apps. The

It describes how the application will work, what resources will be used, etc.

<Aside type="tip" title="Interested in developing Crowdin Apps?">
[Contact Us](https://crowdin.com/contacts) to get exclusive access to the Crowdin Apps SDK, which allows you to create apps in just a few lines of code.
</Aside>

## App Descriptor Structure

The app descriptor is a JSON object with the following structure:
Expand Down
6 changes: 5 additions & 1 deletion src/content/docs/developer/crowdin-apps/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Learn how to build a Crowdin Application using Node.js
slug: developer/crowdin-apps-quick-start
---

import { Steps } from '@astrojs/starlight/components';
import { Steps, Aside } from '@astrojs/starlight/components';

In this article, you'll find information on the fundamental principles of building a Crowdin Application. As a result, you'll be able to build your own app along the way. To accomplish that, you'll be using Node.js and the Heroku platform.

Expand Down Expand Up @@ -37,6 +37,10 @@ At this point, you have a working app with the following structure:

Now the app is ready for deployment on Heroku. As you may notice in the manifest.json, the app in its current state contains only the project-menu module and doesn't require authorization, i.e., the app won't have access to the API.

<Aside type="tip" title="Interested in developing Crowdin Apps?">
[Contact Us](https://crowdin.com/contacts) to get exclusive access to the Crowdin Apps SDK, which allows you to create apps in just a few lines of code.
</Aside>

## Deploying Crowdin App

In this step, you'll deploy the app and install it in your Crowdin account.
Expand Down

0 comments on commit 113adb4

Please sign in to comment.