js/oidc-login
2
0
Fork 0
generated from templates/typescript-library
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

setup repo

Browse Source
This commit is contained in:
James Brumond
2023-08-26 18:55:27 -07:00
parent 01c04cf3ce
commit d6481527dd
5 changed files with 23 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.gitea/workflows/build-and-publish.yaml
View File

@@ -23,8 +23,8 @@ jobs:
- name: Login to package registry - name: Login to package registry
run: | run: |
npm config set @<scope name>:registry https://gitea.jbrumond.me/api/packages/<scope name>/npm/ npm config set @js:registry https://gitea.jbrumond.me/api/packages/js/npm/
npm config set -- '//gitea.jbrumond.me/api/packages/<scope name>/npm/:_authToken' "$NPM_PUBLISH_TOKEN" npm config set -- '//gitea.jbrumond.me/api/packages/js/npm/:_authToken' "$NPM_PUBLISH_TOKEN"
- name: Install dependencies - name: Install dependencies
run: npm ci run: npm ci

4
.gitea/workflows/build-and-test.yaml
View File

@@ -26,8 +26,8 @@ jobs:
- name: Login to package registry - name: Login to package registry
run: | run: |
npm config set @<scope name>:registry https://gitea.jbrumond.me/api/packages/<scope name>/npm/ npm config set @js:registry https://gitea.jbrumond.me/api/packages/js/npm/
npm config set -- '//gitea.jbrumond.me/api/packages/<scope name>/npm/:_authToken' "$NPM_PUBLISH_TOKEN" npm config set -- '//gitea.jbrumond.me/api/packages/js/npm/:_authToken' "$NPM_PUBLISH_TOKEN"
- name: Install dependencies - name: Install dependencies
run: npm ci run: npm ci

8
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{ {
"name": "@templates/typescript-library", "name": "@js/oidc-login",
"version": "1.0.0", "version": "0.1.0",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "@templates/typescript-library", "name": "@js/oidc-login",
"version": "1.0.0", "version": "0.1.0",
"license": "ISC", "license": "ISC",
"devDependencies": { "devDependencies": {
"typescript": "^5.1.3" "typescript": "^5.1.3"

8
package.json
View File

@@ -1,7 +1,7 @@
{ {
"name": "@templates/typescript-library", "name": "@js/oidc-login",
"version": "1.0.0", "version": "0.1.0",
"description": "Template project for creating new TypeScript library packages", "description": "Utilities for implementing OAuth2 / OpenID Connect based login in Node.js services",
"main": "build/index.js", "main": "build/index.js",
"types": "build/index.d.ts", "types": "build/index.d.ts",
"scripts": { "scripts": {
@@ -13,7 +13,7 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://gitea.jbrumond.me/templates/typescript-library.git" "url": "https://gitea.jbrumond.me/js/oidc-login.git"
}, },
"author": "James Brumond <https://jbrumond.me>", "author": "James Brumond <https://jbrumond.me>",
"license": "ISC", "license": "ISC",

28
readme.md
View File

@@ -1,30 +1,24 @@
Template project for creating new TypeScript library packages Utilities for implementing OAuth2 / OpenID Connect based login in Node.js services
--- ---
## Get Started ## Install
### Pull down the code
```bash ```bash
git init # Update project npm config to refer to correct registry for the @js scope
git pull https://gitea.jbrumond.me/templates/typescript-library.git master echo '@js:registry=https://gitea.jbrumond.me/api/packages/js/npm/' >> ./.npmrc
```
### Update configuration npm install --save @js/oidc-login
- In `package.json`, update any fields like `name`, `description`, `repository`, etc. # optional - additional supporting typescript definitions
- In `.gitea/workflows/publish.yaml`, update `<scope name>` placeholders npm install --save-dev @js/types
## Building
```bash
npm run tsc
``` ```
## Usage
```ts
import { } from '@js/oidc-login';
```