Skip to content

Commit 3e7b08a

Browse files
authored
Merge pull request #244 from devforth/docs-for-adapters
Docs for adapters
2 parents 83dbdc4 + 94cc43b commit 3e7b08a

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# AdminForth Adapters
2+
3+
> Overview of all available adapters in the AdminForth ecosystem. Adapters enable integration with external services for features like authentication, email delivery, AI completion, image generation, and file storage.
4+
5+
---
6+
7+
## [📧 Email Adapters](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/EmailAdapter.ts#L17)
8+
9+
>Is used to send emails
10+
11+
### `adminforth-email-adapter-aws-ses`
12+
13+
Enables email delivery via [Amazon Simple Email Service (SES)](https://aws.amazon.com/ses/), suitable for high-volume, programmatic email sending.
14+
15+
### `adminforth-email-adapter-mailgun`
16+
17+
Allows sending transactional or marketing emails using [Mailgun](https://www.mailgun.com/), a developer-friendly email service.
18+
19+
---
20+
21+
## [🔐 OAuth Adapters](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/OAuth2Adapter.ts#L9)
22+
23+
>Is used for integrating third-party login providers using the OAuth 2.0 protocol.
24+
25+
### `adminforth-google-oauth-adapter`
26+
27+
Supports Google sign-in to allow users to authenticate using their Google accounts.
28+
29+
### `adminforth-github-oauth-adapter`
30+
31+
Enables authentication via GitHub accounts, useful for developer tools and open-source apps.
32+
33+
### `adminforth-facebook-oauth-adapter`
34+
35+
Allows users to log in with Facebook credentials.
36+
37+
### `adminforth-keycloak-oauth-adapter`
38+
39+
Connects AdminForth to a [Keycloak](https://www.keycloak.org/) identity provider for enterprise-grade SSO (Single Sign-On).
40+
41+
### `adminforth-microsoft-oauth-adapter`
42+
43+
Supports login through Microsoft accounts including Azure AD, Office365, and Outlook.com.
44+
45+
### `adminforth-twitch-oauth-adapter`
46+
47+
Adds support for Twitch authentication, useful for streaming or creator-oriented platforms.
48+
49+
---
50+
51+
## [🎨 Image Generation Adapters](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/ImageGenerationAdapter.ts#L32)
52+
>Is used for image generating
53+
54+
### `adminforth-image-generation-adapter-openai`
55+
56+
Uses OpenAI’s image models (like DALL·E) to generate images from text prompts.
57+
58+
---
59+
60+
## [💾 Storage Adapters](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/StorageAdapter.ts#L8)
61+
>Is used for storing files
62+
### `adminforth-storage-adapter-amazon-s3`
63+
64+
Stores uploaded files in [Amazon S3](https://aws.amazon.com/s3/), providing scalable cloud storage.
65+
66+
### `adminforth-storage-adapter-local`
67+
68+
Stores files locally on the server’s filesystem. Suitable for development or small-scale self-hosted setups.
69+
70+
---
71+
72+
## [🧠 AI Completion Adapters](https://github.com/devforth/adminforth/blob/917d897c866975a4aee29273377f2c07cb6ddf81/adminforth/types/adapters/CompletionAdapter.ts#L16)
73+
>Is used for AI-powered sentence completion
74+
### `adminforth-completion-adapter-open-ai-chat-gpt`
75+
76+
Integrates AdminForth with OpenAI’s ChatGPT models to provide AI-powered completion and conversational features.
77+
78+
---

0 commit comments

Comments
 (0)