Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dimkl/clerk-koa
Clerk server SDK for usage with Koa
https://github.com/dimkl/clerk-koa
Last synced: 17 days ago
JSON representation
Clerk server SDK for usage with Koa
- Host: GitHub
- URL: https://github.com/dimkl/clerk-koa
- Owner: dimkl
- License: mit
- Created: 2024-03-12T19:52:05.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-03T12:34:41.000Z (4 months ago)
- Last Synced: 2024-11-30T05:02:12.748Z (23 days ago)
- Language: TypeScript
- Size: 227 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: docs/SECURITY.md
Awesome Lists containing this project
README
# @dimkl/clerk-koa
[](https://clerk.com/discord)
[](https://clerk.com/docs?utm_source=github&utm_medium=koa)
[](https://twitter.com/intent/follow?screen_name=ClerkDev)
[Changelog](https://github.com/dimkl/clerk-koa/blob/main/CHANGELOG.md)
·
[Ask a Question](https://github.com/dimkl/clerk-koa/discussions)
---
## Overview
[Clerk](https://clerk.com?utm_source=github&utm_medium=koa) is the easiest way to add authentication and user management to your Node.js application. To gain a better understanding of the Clerk Backend API, refer to the Backend API documentation.
## Getting started
### Prerequisites
- Node.js `>=18.17.0` or later
- Koa installed (follow their [Getting started](https://koajs.com/) guide)
## Installation
```sh
npm install @dimkl/clerk-koa
```
To build the package locally with the TypeScript compiler, run:
```sh
npm run build
```
## Usage
Retrieve your Backend API key from the [API Keys](https://dashboard.clerk.com/last-active?path=api-keys) screen in your Clerk dashboard and set it as an environment variable in a `.env` file:
```sh
CLERK_PUBLISHABLE_KEY=pk_*******
CLERK_SECRET_KEY=sk_******
```
You will then be able to access all the available methods.
```js
import 'dotenv/config'; // To read CLERK_SECRET_KEY
import { clerkClient } from '@dimkl/clerk-koa';
const { data: userList } = await clerkClient.users.getUserList();
```
You will also be able to secure an Koa app.
```js
import Koa from "koa";
import { clerkMiddleware, getAuth } from "@dimkl/clerk-koa";
const app = new Koa();
app.use(clerkMiddleware());
app.use(async (ctx: KoaContext) => {
const auth = getAuth(ctx);
ctx.body = `Hello ${auth?.userId}`;
ctx.status = 200;
});
app.listen(3000);
```
You will also be able to protect a specific endpoint in a Koa app.
```js
import Koa from "koa";
import Router from "@koa/router";
import { clerkMiddleware, getAuth, requireAuth } from "@dimkl/clerk-koa";
const app = new Koa();
app.use(clerkMiddleware());
router.get("/", (ctx) => {
ctx.body = ` Public Homepage ${auth.userId}`;
ctx.status = 200;
});
router.get("/protected", requireAuth, async (ctx: KoaContext) => {
const auth = getAuth(ctx);
ctx.body = `Signed-in user "${auth.userId}"`;
ctx.status = 200;
});
app.use(router.routes()).use(router.allowedMethods());
app.listen(3000);
```
## Support
You can get in touch with me in any of the following ways:
- Create a [GitHub Discussion](https://github.com/dimkl/clerk-koa/discussions) and mention `@dimkl`
## Contributing
We're open to all community contributions!
## Security
`@dimkl/clerk-koa` follows good practices of security, but 100% security cannot be assured.
`@dimkl/clerk-koa` is provided **"as is"** without any **warranty**. Use at your own risk.
_For more information and to report security issues, please refer to the [security documentation](https://github.com/dimkl/clerk-koa/blob/main/docs/SECURITY.md)._
## License
This project is licensed under the **MIT license**.
See [LICENSE](https://github.com/dimkl/clerk-koa/blob/main/LICENSE) for more information.