create-authhero 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +68 -0
- package/package.json +6 -1
- package/src/index.ts +7 -1
- package/templates/sqlite/package.json +0 -17
package/CHANGELOG.md
CHANGED
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
Sure! Here's a `README.md` file for your CLI package:
|
|
2
|
+
|
|
3
|
+
````markdown
|
|
4
|
+
# create-authhero
|
|
5
|
+
|
|
6
|
+
`create-authhero` is a command-line tool for creating a new AuthHero project. It sets up a new project with the necessary configuration and template files, including SQLite templates.
|
|
7
|
+
|
|
8
|
+
## Usage
|
|
9
|
+
|
|
10
|
+
To create a new AuthHero project, run the following command:
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
npm create authhero <project-name>
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
If you don't specify a project name, you will be prompted to enter one.
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
|
|
20
|
+
```sh
|
|
21
|
+
npm create authhero my-auth-project
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
This will create a new directory named `my-auth-project` with the following structure:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
my-auth-project
|
|
28
|
+
├── package.json
|
|
29
|
+
└── src
|
|
30
|
+
└── ... (template files)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
The generated project is a small wrapper around the [authhero](https://www.npmjs.com/package/authhero) npm library which makes it easy to keep up to date with the latest changes. All the files in the `src` directory are templates that you can modify to fit your needs.
|
|
34
|
+
|
|
35
|
+
### Options
|
|
36
|
+
|
|
37
|
+
- `project-name` (optional): The name of the new project. If not provided, you will be prompted to enter it.
|
|
38
|
+
|
|
39
|
+
## Project Setup
|
|
40
|
+
|
|
41
|
+
When you run the `create-authhero` command, you will be prompted to enter some additional information for your new project:
|
|
42
|
+
|
|
43
|
+
- Project name
|
|
44
|
+
|
|
45
|
+
These details will be included in the `package.json` file of your new project.
|
|
46
|
+
|
|
47
|
+
## Development
|
|
48
|
+
|
|
49
|
+
To contribute to this project, clone the repository and install the dependencies:
|
|
50
|
+
|
|
51
|
+
```sh
|
|
52
|
+
git clone https://github.com/markusahlstrand/authhero
|
|
53
|
+
cd create-authhero
|
|
54
|
+
npm install
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
MIT
|
|
60
|
+
|
|
61
|
+
## Author
|
|
62
|
+
|
|
63
|
+
Markus Ahlstrand
|
|
64
|
+
|
|
65
|
+
## Acknowledgments
|
|
66
|
+
|
|
67
|
+
- [Commander.js](https://github.com/tj/commander.js) - Command-line interfaces made easy
|
|
68
|
+
- [Inquirer.js](https://github.com/SBoudrias/Inquirer.js) - A collection of common interactive command line user interfaces
|
package/package.json
CHANGED
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-authhero",
|
|
3
|
-
"
|
|
3
|
+
"homepage": "https://authhero.net",
|
|
4
|
+
"repository": {
|
|
5
|
+
"type": "git",
|
|
6
|
+
"url": "https://github.com/markusahlstrand/authhero"
|
|
7
|
+
},
|
|
8
|
+
"version": "0.1.1",
|
|
4
9
|
"type": "module",
|
|
5
10
|
"main": "dist/create-authhero.js",
|
|
6
11
|
"bin": {
|
package/src/index.ts
CHANGED
|
@@ -55,7 +55,13 @@ program
|
|
|
55
55
|
description: answers.description,
|
|
56
56
|
author: answers.author,
|
|
57
57
|
scripts: {
|
|
58
|
-
|
|
58
|
+
dev: "bun --watch src/index.js",
|
|
59
|
+
start: "bun src/index.js",
|
|
60
|
+
},
|
|
61
|
+
dependencies: {
|
|
62
|
+
"@hono/zod-openapi": "^0.14.9",
|
|
63
|
+
authhero: "^0.2.0",
|
|
64
|
+
hono: "^4.4.10",
|
|
59
65
|
},
|
|
60
66
|
},
|
|
61
67
|
null,
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "sqlite",
|
|
3
|
-
"version": "1.0.0",
|
|
4
|
-
"description": "",
|
|
5
|
-
"main": "index.js",
|
|
6
|
-
"scripts": {
|
|
7
|
-
"dev": "bun src/index.ts"
|
|
8
|
-
},
|
|
9
|
-
"keywords": [],
|
|
10
|
-
"author": "",
|
|
11
|
-
"license": "MIT",
|
|
12
|
-
"dependencies": {
|
|
13
|
-
"@hono/zod-openapi": "^0.14.9",
|
|
14
|
-
"authhero": "^0.1.0",
|
|
15
|
-
"hono": "^4.4.10"
|
|
16
|
-
}
|
|
17
|
-
}
|