https://github.com/zeeshanmukhtar1/next-auth
A Straightforward Next.js auth system with key API endpoints for signup, login, profile retrieval, email verification, logout, and password recovery.
https://github.com/zeeshanmukhtar1/next-auth
authentication nextjs
Last synced: 2 months ago
JSON representation
A Straightforward Next.js auth system with key API endpoints for signup, login, profile retrieval, email verification, logout, and password recovery.
- Host: GitHub
- URL: https://github.com/zeeshanmukhtar1/next-auth
- Owner: ZeeshanMukhtar1
- Created: 2024-03-26T17:39:05.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T18:04:34.000Z (almost 2 years ago)
- Last Synced: 2024-07-08T22:25:25.953Z (almost 2 years ago)
- Topics: authentication, nextjs
- Language: TypeScript
- Homepage:
- Size: 277 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Next-Auth
Next-Auth is a straightforward Next.js authentication system with key API endpoints for signup, login, profile retrieval, email verification, logout, and password recovery.
## Getting Started
To get started with Next-Auth, follow these steps:
1. Clone this repository by running `git clone https://github.com/ZeeshanMukhtar1/Next-Auth.git`.
2. Run `npm install` to install the dependencies.
3. Create a `.env` file and follow the `.env.sample` file to add the required environment variables.
4. Run `npm run dev` to start the development server.
5. Open [http://localhost:3000](http://localhost:3000) in your browser to see the result.
6. You can start editing the pages in the `app` directory. The page auto-updates as you edit the files.
## Features
- **Signup**: Allows users to sign up for an account.
- **Login**: Enables users to log in to their accounts.
- **Profile Retrieval**: Fetches user profile details.
- **Email Verification**: Sends verification emails to users.
- **Logout**: Logs users out of their accounts.
- **Password Recovery**: Allows users to recover their passwords.
## Contributing
We want passwword recovery to be as simple as possible. If you have any ideas, suggestions, or improvements, please open an issue or submit a pull request.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.