mirror of
https://github.com/SrIzan10/next-auth.git
synced 2026-05-01 10:55:20 +00:00
90b4dbc194
* chore: simplify note header * chore: simplify example-gatsby readme header * chore: fix broken docs README badge * chore: rm docs README prerelease shield
67 lines
2.2 KiB
Markdown
67 lines
2.2 KiB
Markdown
<p align="center">
|
|
<br/>
|
|
<a href="https://next-auth.js.org" target="_blank"><img width="150px" src="https://next-auth.js.org/img/logo/logo-sm.png" /></a>
|
|
<h3 align="center">NextAuth.js</h3>
|
|
<p align="center">Authentication for Next.js</p>
|
|
<p align="center">
|
|
Open Source. Full Stack. Own Your Data.
|
|
</p>
|
|
<p align="center" style="align: center;">
|
|
<a href="https://github.com/nextauthjs/next-auth/actions/workflows/release.yml?query=workflow%3ARelease">
|
|
<img src="https://github.com/nextauthjs/next-auth/actions/workflows/release.yml/badge.svg" alt="Release" />
|
|
</a>
|
|
<a href="https://packagephobia.com/result?p=next-auth">
|
|
<img src="https://packagephobia.com/badge?p=next-auth" alt="Bundle Size"/>
|
|
</a>
|
|
<a href="https://www.npmtrends.com/next-auth">
|
|
<img src="https://img.shields.io/npm/dm/next-auth" alt="Downloads" />
|
|
</a>
|
|
<a href="https://github.com/nextauthjs/next-auth/stargazers">
|
|
<img src="https://img.shields.io/github/stars/nextauthjs/next-auth" alt="Github Stars" />
|
|
</a>
|
|
<a href="https://www.npmjs.com/package/next-auth">
|
|
<img src="https://img.shields.io/github/v/release/nextauthjs/next-auth?label=latest" alt="Github Stable Release" />
|
|
</a>
|
|
</p>
|
|
</p>
|
|
|
|
## Overview
|
|
|
|
This is the repository for the documentation page for NextAuth.js!
|
|
|
|
NextAuth.js is a complete open source authentication solution for [Next.js](http://nextjs.org/) applications.
|
|
|
|
This documentation site is based on the [Docusaurus](https://docusaurus.io) framework.
|
|
|
|
## Getting Started
|
|
|
|
To start a local environment of this project, please do the following.
|
|
|
|
1. Clone the repository.
|
|
|
|
```bash
|
|
$ git clone https://github.com/nextauthjs/docs.git
|
|
```
|
|
|
|
2. Install dependencies
|
|
|
|
```bash
|
|
$ npm install
|
|
```
|
|
|
|
3. Start the development server
|
|
|
|
```bash
|
|
$ npm start
|
|
```
|
|
|
|
And thats all! Now you should have a local copy of this docs site running at [localhost:3000](http://localhost:3000)!
|
|
|
|
## 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/next-auth/blob/main/CONTRIBUTING.md).
|
|
|
|
## License
|
|
|
|
ISC
|