https://github.com/arijitcodes/passportjs-oauth-local-jwt-combined
A Demo Implementation of Authentication using a Combination of PassportJS OAuth 2.0 & Local Auth Strategy - together - without passport sessions - using custom JWT with custom Middleware - in an Express API Server (NodeJS, ExpressJS, PassportJS, MongoDB, Mongoose)
https://github.com/arijitcodes/passportjs-oauth-local-jwt-combined
Last synced: about 2 months ago
JSON representation
A Demo Implementation of Authentication using a Combination of PassportJS OAuth 2.0 & Local Auth Strategy - together - without passport sessions - using custom JWT with custom Middleware - in an Express API Server (NodeJS, ExpressJS, PassportJS, MongoDB, Mongoose)
- Host: GitHub
- URL: https://github.com/arijitcodes/passportjs-oauth-local-jwt-combined
- Owner: arijitcodes
- Created: 2025-02-17T17:25:00.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-02-17T17:29:13.000Z (3 months ago)
- Last Synced: 2025-02-17T18:35:53.020Z (3 months ago)
- Language: JavaScript
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# passportjs-oauth-local-jwt-combined
## Author
Author : [Arijit Banerjee](https://www.github.com/ArijitCodes)
About : Full Stack Web Developer | Cyber Security Enthusiast | Actor
Social Media :
[ Instagram](https://www.instagram.com/arijit.codes)
[ LinkedIn](https://www.linkedin.com/in/arijitban)
[ GitHub](https://github.com/ArijitCodes)
[ Website](https://iamarijit.dev)
Email: [email protected]
## Functionalities and Technologies Used
`Stack` : NodeJS, ExpressJS, MongoDB
`Technologies Used` : NodeJS, ExpressJS, MongoDB, Mongoose, PassportJS, JSONWebToken (JWT), Dotenv, Axios, Bun, ReactJS, Material-UI, Docker, Docker Compose, Expo, React Native, etc.
`Functionalities` :
- User Registration with Local Strategy
- OAuth 2.0 Authentication with Google and GitHub
- JWT Token Generation and Verification
- Middleware for JWT Authentication
- Dynamic Configuration for OAuth Providers
- Error Handling and Logging
- Theming and Dark Mode Toggle
- Profile Management
- Docker and Docker Compose for Containerization
- Mobile App with OAuth Support and Deep Linking
## From the Developer:
This repo demonstrates a combined authentication system using PassportJS with Local Strategy, OAuth 2.0, and JWT. It is designed to be modular and easily extendable to add more OAuth providers.
Additionally, it includes a client web app, built with React, and a mobile app, built with React Native and Expo, that demonstrate the implementation of the backend.
If you have any suggestions, please feel free to leave the suggestions. Constructive Criticism is always appreciated.
### Note on OAuth2 Workflow:
When working with OAuth2 in a development environment, you might face issues with Expo Go or a development build not being able to find `localhost` for the server. This is because the Expo environment is simulated and cannot access `localhost` on your development machine. However, if you set up the entire workflow using your local IP address, it will work. We tested GitHub OAuth with a local IP address, and it worked successfully.
After we built the web app, things were working fine. However, when we started with the mobile app, we faced the above issue. To save time, we hardcoded the temporary local IP in places and used it to register as the authorized callback URL in GitHub. Hence, it worked.
## Tips
### Using Docker and Docker Compose
#### Backend
1. Navigate to the root directory of the project.
2. Build the Docker image:
```sh
docker compose build
```
3. Start the services:
```sh
docker compose up
```
Make sure to set the environment variables in your system or in a .env file.
PS: If you go with Docker, the backend app will be available on port 5000.
#### Client Web Application
1. Navigate to the webapp directory.
2. Build and start the Docker container using Docker Compose:
```sh
docker compose up --build
```
The client web application will be available on port 80.
### Without Docker
#### Backend
1. Clone the project and run:
```sh
npm install
```
2. Create a file named `.env` in the root. You can use the `.env.sample` file as a reference for the ENV Variables that are needed for the app.
3. Set up the required Env Variables to be used in the app.
4. Run:
```sh
npm start
```
#### Client Web Application
1. Navigate to the webapp directory.
2. Install dependencies:
```sh
npm install
```
3. Create a file named .env in the webapp directory. You can use the .env.sample file as a reference for the ENV Variables that are needed for the app.
4. Set up the required Env Variables to be used in the app.
5. Run:
```sh
npm start
```
#### Mobile App
1. Navigate to the mobileapp directory.
2. Install dependencies:
```sh
bun install
```
3. Create a file named .env in the mobileapp directory. You can use the .env.sample file as a reference for the ENV Variables that are needed for the app.
4. Set up the required Env Variables to be used in the app.
5. Run:
```sh
bun run start
```