Skip to content

Commit

Permalink
chore(release): package published on npm. Includes
Browse files Browse the repository at this point in the history
- version: 0.0.1 published
- add documentation in the README.md on how to install
- set the configuration to deploy the package
  • Loading branch information
halvaradop committed Jul 23, 2024
1 parent 90fe5fa commit 86bf38f
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 7 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# auth-init
auth-init is an initializer that facilitates and accelerates the setup of projects with authentication using auth.js. It supports the three main frameworks offered by auth.js:
# @halvaradop/auth-init
@halvaradop/auth-init is an initializer that facilitates and accelerates the setup of projects with authentication using auth.js. It supports the three main frameworks offered by auth.js:
- NextJs
- SvelteKit
- Express

It simplifies the configuration to create a basic setup for using auth.js with your favorite framework, helping you focus on incorporating custom authentication configurations provided by auth.js.

## Installation
To install the initializer of authentication with Auth.js, you should install it via npm. For more information about [Auth.js](https://authjs.dev/), you can check their documentation. The command to install the package is:
```bash
npm i -g @halvaradop/auth-init
```
4 changes: 4 additions & 0 deletions features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
auth-init --help

auth-init --secret
auth-init --providers
13 changes: 8 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
{
"name": "auth-init",
"version": "1.0.0",
"name": "@halvaradop/auth-init",
"version": "0.1.0",
"main": "dist/index.js",
"description": "CLI tool to initialize a project with auth.js",
"bin": {
"auth-init": "dist/index.js"
},
"scripts": {
"dev": "tsc -w",
"build": "tsc",
"link": "npm unlink auth-init && chmod +x dist/index.js && npm link auth-init",
"link": "npm unlink @halvaradop/auth-init && chmod +x dist/index.js && npm link @halvaradop/auth-init",
"uninstall": "npm uninstall @auth/express @auth/sveltekit next-auth",
"start": "rm -rf auth.js && npm run uninstall && node dist/index.js"
},
Expand All @@ -20,11 +23,11 @@
"authentication",
"authorization"
],
"author": "",
"author": "Hernan Alvarado <[email protected]>",
"license": "MIT",
"repository": {
"type": "git",
"url": "git+https://github.com/halvaradop/auth-init-cli.git"
"url": "git+https://github.com/halvaradop/auth-init.git"
},
"bugs": {
"url": "https://github.com/halvaradop/auth-init/issues"
Expand Down
4 changes: 4 additions & 0 deletions src/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"framework": "NextJs",
"baseConfigPath": "auth.ts"
}

0 comments on commit 86bf38f

Please sign in to comment.