Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shivabhattacharjee/sso
https://github.com/shivabhattacharjee/sso
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/shivabhattacharjee/sso
- Owner: ShivaBhattacharjee
- Created: 2024-05-28T10:59:35.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-05-28T18:34:47.000Z (6 months ago)
- Last Synced: 2024-05-29T02:51:44.228Z (6 months ago)
- Language: TypeScript
- Size: 248 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
SSO
![NextJs](https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white)
[![Deno](https://github.com/ShivaBhattacharjee/sso/actions/workflows/deno.yml/badge.svg)](https://github.com/ShivaBhattacharjee/sso/actions/workflows/deno.yml)
![jwt token](http://jwt.io/img/badge-compatible.svg)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
![GitHub repo size](https://img.shields.io/github/repo-size/shivabhattacharjee/sso)
A Single Sign-On (SSO) system built with Next.js, PostgreSQL, Prisma, and Tailwind CSS.
View Demo
.
Report Bug
.
Request Feature
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Local](#local)
- [Update allowed domain after cloning](#update-allowed-domain-after-cloning)
- [Start db through docker](#start-db-through-docker)
- [Prisma studio](#prisma-studio)
- [React-Email Dev Mode](#react-email-dev-mode)
- [Usage Demo](#usage-demo)
- [Host your own](#host-your-own)
- [Contributing](#contributing)
- [Creating A Pull Request](#creating-a-pull-request)
- [Raising an issue](#raising-an-issue)
- [Code of conduct](#code-of-conduct)
- [License](#license)
- [ScreenShots](#screenshots)
- [Login](#login)
- [Register](#register)
- [Visit SSO](#visit-sso)
- [Authors](#authors)## About The Project
![image](https://github.com/ShivaBhattacharjee/sso/assets/95211406/1ec7a2fd-eb07-4180-be05-9cb478249b4c)SSO is a Single Sign-On (SSO) system that allows users to seamlessly authenticate across multiple applications using a single set of credentials. Built with Next.js, PostgreSQL, Prisma, and Tailwind CSS, SSO offers a secure and efficient way to manage user authentication.
## Built With
SSO is built using:
* [NextJS](https://nextjs.org)
* [TailwindCSS](https://tailwindcss.com/)
* [PostgreSQL](https://www.postgresql.org/)
* [Prisma](https://www.prisma.io/)## Getting Started
### Prerequisites
Git is a distributed version control system used for software development. It allows multiple developers to work on the same codebase simultaneously, keeping track of changes and managing versions. It also enables users to revert changes and collaborate more effectively.
BunJS is a JavaScript runtime, package manager, test runner, and bundler built from scratch using the Zig programming language. It was designed by Jarred Sumner as a drop-in replacement for Node.js. Bun uses WebKit's JavaScriptCore as the JavaScript engine, unlike Node.js and Deno, which both use V8.
### Installation
### Local
```Rename .env.example to .env.local and fill the required fields```#### Update allowed domain after cloning
[middleware.ts](https://github.com/ShivaBhattacharjee/sso/blob/main/src/middleware.ts)
Update this function
```bash
const isAllowedDomain = (hostname: string, port: string): boolean => {
return hostname.endsWith(".theshiva.xyz") || hostname === "theshiva.xyz" || (hostname === "localhost" && (port === "" || port === "3000"));
};
``````bash
git clone https://github.com/ShivaBhattacharjee/SSO
```
```
cd SSO
```
```
bun install
```#### Start db through docker
```bash
docker compose up
``````
bun migrate:dev
```
```
bun dev
```
Server will start at http://localhost:3000/### Prisma studio
```
bun prisma:studio
```### React-Email Dev Mode
```bash
bun email:dev
```## Usage Demo
Visit this [REPO](https://github.com/ShivaBhattacharjee/sso-auth-demo) to get a grasp of implementing it in your own project.
## Host your own
* ## Vercel
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FShivaBhattacharjee%2FSSO)
* ## Netlify
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/ShivaBhattacharjee/SSO)
* ## Render
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/ShivaBhattacharjee/SSO)
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/ShivaBhattacharjee/SSO/issues) to discuss it* Please make sure you check your spelling and grammar.
### Creating A Pull Request
Wanna contribute to SSO?
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/FeatureName`)
3. Commit your Changes (`git commit -m 'Add some FeatureName'`)
4. Push to the Branch (`git push origin feature/FeatureName`)
5. Open a Pull Request## Raising an issue
If you're experiencing any problems with SSO, please be sure to review our [issue template](https://github.com/ShivaBhattacharjee/SSO/tree/main/.github/ISSUE_TEMPLATE) before opening a new issue. The template includes a list of questions and prompts that will help us better understand the issue you're experiencing, and it will ensure that we have all of the necessary information to investigate the problem.
We kindly ask that you provide as much detail as possible when submitting an issue, including steps to reproduce the problem, any error messages that you have seen, and any other relevant information. This will help us to identify and fix the issue more quickly.
Thank you for your cooperation, and we look forward to hearing from you!
## Code of conduct
Developers are requested to go through our code of conduct thoroughly to maintain a peaceful environment within our project.
## License
Distributed under the Apache License 2.0. See [LICENSE](https://github.com/ShivaBhattacharjee/SSO/blob/main/LICENSE) for more information.
## ScreenShots
### Login
![image](https://github.com/ShivaBhattacharjee/sso/assets/95211406/65a1f562-2525-46ab-a2be-b959e12ba5b7)### Register
![image](https://github.com/ShivaBhattacharjee/sso/assets/95211406/fc269476-88d1-4dc6-b3be-42181e6dfa35)#### Visit SSO
## Authors
- **Shiva Bhattacharjee** - [Shiva Bhattacharjee](https://github.com/ShivaBhattacharjee) - *SSO*
See also the list of [contributors](https://github.com/ShivaBhattacharjee/SSO/contributors) who participated in this project.