Skip to content

Commit

Permalink
Add github workflow to publish react sdk (#62)
Browse files Browse the repository at this point in the history
  • Loading branch information
byn9826 authored Aug 2, 2024
1 parent 300dcd6 commit 9a14fdb
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 2 deletions.
30 changes: 30 additions & 0 deletions .github/workflows/react-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: react-publish CI

on:
workflow_dispatch:

jobs:
publish:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: '18'

- name: Install dependencies
run: npm install

- name: Build package
run: npm run build

- name: Publish to npm
run: |
cd react-sdk
npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,23 @@
## Why Melody Auth?

### 1. Self-Hosted
[Server Setup](https://auth.valuemelody.com/auth-server.html)
- Deploy the entire system within minutes
- Leverage Cloudflare's infrastructure to minimize DevOps overhead
- Full access to the source code

### 2. Admin Panel
[Admin Panel Setup](https://auth.valuemelody.com/admin-panel.html)
- Web interface for managing apps, users, scopes, and roles
- Serves as a simple implementation example using the React SDK and Server-to-Server REST API

### 3. React SDK
[React SDK Guidance](https://auth.valuemelody.com/react-sdk.html)
- Enables smooth integration between React applications and the authentication server
- Implements Proof Key for Code Exchange (PKCE) for enhanced security

### 4. Server-to-Server REST API
[Rest API Swagger](https://auth-server.valuemelody.com/api/v1/swagger)
- Secure communication channel for backend services using client credentials token exchange flow
- Provides functionalities for managing apps, users, scopes, and roles with scope protection

Expand Down
3 changes: 3 additions & 0 deletions react-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,6 @@ Melody Auth React SDK facilitates seamless interaction between React application
```
npm install @melody-auth/react --save
```

## Detailed Documentation
For more detailed information, please see [Detailed Documentation](https://auth.valuemelody.com/react-sdk.html).
3 changes: 1 addition & 2 deletions react-sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
},
"scripts": {
"build": "rm -rf ./dist && tsc --build",
"type:check": "tsc --noEmit",
"release": "rm -rf ./dist && npm run compile && npm publish"
"type:check": "tsc --noEmit"
}
}

0 comments on commit 9a14fdb

Please sign in to comment.