Skip to content

feat: update README.md header, security and sponsors sections #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Bug report
description: Report an issue so we can improve
labels: [triage, bug]
body:
- type: markdown
attributes:
value: |
**NOTE:** Issues that are potentially security related should be reported to us by following the [Security guidelines](https://next-auth.js.org/security) rather than on GitHub.
Thanks for taking the time to fill out this issue after reading/searching through the [documentation](https://next-auth.js.org) first!
Is this your first time contributing? Check out this video: https://www.youtube.com/watch?v=cuoNzXFLitc

### Important :exclamation:

_Providing incorrect/insufficient information or skipping steps to reproduce the issue may result in closing the issue or converting to a discussion without further explanation._

If you have a generic question specific to your project, it is best asked in Discussions under the [Questions category](https://github.com/nextauthjs/next-auth/discussions/new?category=Questions)
- type: textarea
attributes:
label: Environment
description: |
Run this command in your project's root folder and paste the result:

`npx envinfo --system --binaries --browsers --npmPackages "{next,react,next-auth,@auth/*}"`

Alternatively, you can manually gather the version information from your package.json for these packages: "next", "react" and "next-auth". Please also mention your OS and Node.js version, as well as the browser you are using.
validations:
required: true
# Not sure how feasible it is to make reproduction URLs for a CLI :thinking:
# - type: input
# attributes:
# label: Reproduction URL
# description: A URL to a repository/code that clearly reproduces your issue. You can use our [`next-auth-example`](https://github.com/nextauthjs/next-auth-example) template repository to get started more easily, or link to your project if it's public
# validations:
# required: true
- type: textarea
attributes:
label: Describe the issue
description: Describe us what the issue is and what have you tried so far to fix it. Add any extra useful information in this section. Feel free to use screenshots (but prefer [code blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) over a picture of your code) or a video explanation.
validations:
required: true
- type: textarea
attributes:
label: How to reproduce
description: Explain with clear steps how to reproduce the issue
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: Explain what should have happened instead of what actually happened
validations:
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/nextauthjs/next-auth/discussions/new?category=questions
about: Ask questions and discuss with other community members
- name: Feature request
url: https://github.com/nextauthjs/next-auth/discussions/new?category=ideas
about: Feature requests should be opened as discussions
37 changes: 37 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!--
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated!

Please fill out the information below to expedite the review and (hopefully)
merge of your pull request!

**NOTE**:

- It's a good idea to open an issue first to discuss potential changes.
- Please make sure that you are _NOT_ opening a PR to fix a potential security vulnerability. Instead, please follow the [Security guidelines](https://github.com/nextauthjs/.github/blob/main/SECURITY.md) to disclose the issue to us confidentially.

-->

## ☕️ Reasoning

<!-- What changes are being made? What feature/bug is being fixed here? -->

## 🧢 Checklist

- [ ] Documentation
- [ ] Tests
- [ ] Ready to be merged

## 🎫 Affected issues

<!--
Please [scout and link issues](https://github.com/nextauthjs/next-auth/issues) that might be solved by this PR. And include text like the following to close them automatically when this is merged:

Fixes: INSERT_ISSUE_LINK_HERE
-->

## 📌 Resources

- [Security guidelines](https://github.com/nextauthjs/.github/blob/main/SECURITY.md)
- [Contributing guidelines](https://github.com/nextauthjs/.github/blob/main/CONTRIBUTING.md)
- [Code of conduct](https://github.com/nextauthjs/.github/blob/main/CODE_OF_CONDUCT.md)
- [Contributing to Open Source](https://kcd.im/pull-request)
20 changes: 20 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# https://github.com/probot/stale#usage

daysUntilStale: 60
daysUntilClose: 7
exemptLabels:
- pinned
- security
- priority
- bug
- triage
- accepted
staleLabel: stale
markComment: >
It looks like this issue did not receive any activity for 60 days.
It will be closed in 7 days if no further activity occurs. If you think your issue
is still relevant, commenting will keep it open. Thanks!
closeComment: >
To keep things tidy, we are closing this issue for now.
If you think your issue is still relevant, leave a comment
and we might reopen it. Thanks!
135 changes: 134 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,27 @@
# Auth.js CLI
<p align="center">
<br/>
<a href="https://authjs.dev" target="_blank"><img width="96px" src="https://authjs.dev/img/logo/logo-sm.png" /></a>
<h3 align="center">Auth.js CLI</h3>
<p align="center">Authentication for the Web.</p>
<p align="center">Open Source. Full Stack. Own Your Data.</p>
<p align="center" style="align: center;">
<a href="https://npm.im/auth">
<img src="https://img.shields.io/badge/TypeScript-blue?style=flat-square" alt="TypeScript" />
</a>
<a href="https://www.npmtrends.com/auth">
<img src="https://img.shields.io/npm/dm/auth?style=flat-square" alt="Downloads" />
</a>
<a href="https://github.com/nextauthjs/auth-cli/stargazers">
<img src="https://img.shields.io/github/stars/nextauthjs/auth-cli?style=flat-square" alt="Github Stars" />
</a>
<a href="https://www.npmjs.com/package/auth">
<img src="https://img.shields.io/github/v/release/nextauthjs/auth-cli?label=latest&style=flat-square" alt="Github Stable Release" />
</a>
</p>
<p align="center">
Auth.js CLI is a multi-purpose CLI to get started and manage Auth.js projects.
</p>
</p>

The CLI tool by [Auth.js](https://authjs.dev) to supercharge your authentication workflow.

Expand Down Expand Up @@ -27,6 +50,116 @@ Commands:
help [command] display help for command
```

## Security

If you think you have found a vulnerability (or are not sure) in Auth.js or any of the related packages (i.e. Adapters), we ask you to read our [Security Policy](https://authjs.dev/security) to reach out responsibly. Please do not open Pull Requests/Issues/Discussions before consulting with us.

## Acknowledgements

Special thanks to Craig for the `auth` package name on npm.

### Sponsors

We have an [OpenCollective](https://opencollective.com/nextauth) for companies and individuals looking to contribute financially to the project!

<!--sponsors start-->
<table>
<tbody>
<tr>
<td align="center" valign="top">
<a href="https://clerk.com?utm_source=sponsorship&utm_medium=github&utm_campaign=authjs&utm_content=sponsor" target="_blank">
<img width="108" src="https://avatars.githubusercontent.com/u/49538330?s=200&v=4" alt="Clerk Logo" />
</a><br />
<div>Clerk</div>
<sub>💵</sub>
</td>
<td align="center" valign="top">
<a href="https://vercel.com" target="_blank">
<img width="108" src="https://avatars.githubusercontent.com/u/14985020?s=200&v=4" alt="Vercel Logo" />
</a><br />
<div>Vercel</div>
<sub>💵☁️</sub>
</td>
<td align="center" valign="top">
<a href="https://fusionauth.io" target="_blank">
<img width="108" src="https://avatars.githubusercontent.com/u/41974756?s=200&v=4" alt="FusionAuth Logo" />
</a><br />
<div>FusionAuth</div>
<sub>💵</sub>
</td>
<td align="center" valign="top">
<a href="https://www.beyondidentity.com" target="_blank">
<img width="108" src="https://avatars.githubusercontent.com/u/69811361?s=200&v=4" alt="Beyond Identity Logo" />
</a><br />
<div>Beyond Identity</div>
<sub>💵</sub>
</td>
<td align="center" valign="top">
<a href="https://stytch.com" target="_blank">
<img width="108" src="https://avatars.githubusercontent.com/u/69983493?s=200&v=4" alt="Stytch Logo" />
</a><br />
<div>Stytch</div>
<sub>💵</sub>
</td>
<td align="center" valign="top">
<a href="https://prisma.io" target="_blank">
<img width="108" src="https://avatars.githubusercontent.com/u/17219288?s=200&v=4" alt="Prisma Logo" />
</a><br />
<div>Prisma</div>
<sub>💵</sub>
</td>
<td align="center" valign="top">
<a href="https://lowdefy.com" target="_blank">
<img width="108" src="https://avatars.githubusercontent.com/u/47087496?s=200&v=4" alt="Lowdefy Logo" />
</a><br />
<div>Lowdefy</div>
<sub>💵</sub>
</td>
<td align="center" valign="top">
<a href="https://workos.com" target="_blank">
<img width="108" src="https://avatars.githubusercontent.com/u/47638084?s=200&v=4" alt="WorkOS Logo" />
</a><br />
<div>WorkOS</div>
<sub>💵</sub>
</td>
</tr>
<tr>
<td align="center" valign="top">
<a href="https://www.descope.com" target="_blank">
<img width="108" src="https://avatars.githubusercontent.com/u/97479186?s=200&v=4" alt="Descope Logo" />
</a><br />
<div>Descope</div>
<sub>💵</sub>
</td>
<td align="center" valign="top">
<a href="https://checklyhq.com" target="_blank">
<img width="108" src="https://avatars.githubusercontent.com/u/25982255?s=200&v=4" alt="Checkly Logo" />
</a><br />
<div>Checkly</div>
<sub>☁️</sub>
</td>
<td align="center" valign="top">
<a href="https://superblog.ai/" target="_blank">
<img width="108" src="https://d33wubrfki0l68.cloudfront.net/cdc4a3833bd878933fcc131655878dbf226ac1c5/10cd6/images/logo_bolt_small.png" alt="superblog Logo" />
</a><br />
<div>superblog</div>
<sub>☁️</sub>
</td>
</tr>
</tbody>
</table>

- 💵 Financial Sponsor
- ☁️ Infrastructure Support

<br />
<!--sponsors end-->

## Contributing

We're open to all community contributions! If you'd like to contribute in any way, please first read
our [Contributing Guide](https://github.com/nextauthjs/.github/blob/main/CONTRIBUTING.md).

## License

MIT
15 changes: 11 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
{
"name": "auth",
"description": "The CLI tool by Auth.js to supercharge your authentication workflow.",
"homepage": "https://cli.authjs.dev",
"version": "1.0.2",
"homepage": "https://cli.authjs.dev",
"repository": "https://github.com/nextauthjs/auth-cli.git",
"description": "The CLI tool by Auth.js to supercharge your authentication workflow.",
"author": "Balázs Orbán <[email protected]>",
"contributors": [
"Balázs Orbán <[email protected]>",
"Nico Domino <[email protected]>",
"Lluis Agusti <[email protected]>",
"Thang Huu Vu <[email protected]>"
],
"license": "MIT",
"type": "module",
"bin": {
"auth": "index.js"
Expand All @@ -17,8 +26,6 @@
"authjs",
"cli"
],
"author": "Balázs Orbán <[email protected]>",
"license": "MIT",
"dependencies": {
"commander": "11.1.0"
},
Expand Down