https://github.com/agentnovax/agentnovax-api-auth-springboot-firebase
AgentNovaXAuthAPI is a Spring Boot API integrating Firebase Authentication and PostgreSQL for secure, scalable user authentication. It supports Google, Microsoft, Apple, and Facebook logins, validates Firebase ID tokens, and includes JWT generation for session management. A complete OAuth solution for modern authentication systems.
https://github.com/agentnovax/agentnovax-api-auth-springboot-firebase
api authentication authentication-backend firebase firebase-auth iam identity-management springboot
Last synced: about 10 hours ago
JSON representation
AgentNovaXAuthAPI is a Spring Boot API integrating Firebase Authentication and PostgreSQL for secure, scalable user authentication. It supports Google, Microsoft, Apple, and Facebook logins, validates Firebase ID tokens, and includes JWT generation for session management. A complete OAuth solution for modern authentication systems.
- Host: GitHub
- URL: https://github.com/agentnovax/agentnovax-api-auth-springboot-firebase
- Owner: agentnovax
- License: other
- Created: 2025-01-19T07:23:07.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-01-25T04:13:35.000Z (9 months ago)
- Last Synced: 2025-04-02T04:23:06.243Z (6 months ago)
- Topics: api, authentication, authentication-backend, firebase, firebase-auth, iam, identity-management, springboot
- Language: Java
- Homepage: https://www.agentnovax.com
- Size: 224 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 
---
## AgentNovaX
Welcome to **AgentNovaX**! 🌍✨
At [AgentNovaX](https://www.agentnovax.com/), our vision is to create a world where **innovation**, **collaboration**, **technology**, and **sustainability** work hand-in-hand to empower communities. We aim to provide tools that **simplify tasks**, **increase productivity**, and contribute to a **better planet**. Through **creativity**, **inclusivity**, and **environmental consciousness**, we strive to inspire a global movement toward shared success and continuous growth. 🌱💡
---
## **AgentNovaX-SpringFirebaseAuthAPI** - Spring Boot Project with PostgreSQL and Firebase Authentication 🚀
**AgentNovaX-SpringFirebaseAuthAPI** is a robust **Spring Boot API application** that integrates **Firebase Authentication** and **PostgreSQL** to provide secure and scalable user authentication solutions. The project supports seamless user registration, validation of Firebase ID tokens, and integrates with multiple authentication providers like **Google**, **Microsoft**, **Apple**, and **Facebook**. Additionally, it includes **JWT token generation** for secure session management, offering a simple yet powerful solution for building modern authentication systems.
Perfect for developers looking to integrate **Firebase authentication** into their **Spring Boot** applications with **PostgreSQL** as the backend data store, providing a complete **OAuth solution**.
---
## Features 🔑
- User registration with **Firebase Authentication** 🔐
- Validates ID tokens using **Firebase Admin APIs** ✅
- Stores user information in a **PostgreSQL** database 💾
- Supports multiple authentication providers (Google, Microsoft, Apple, Facebook) 🌐
- Returns **JWT Token** and session for the application 🔑
---
## Prerequisites ⚙️
### Tools and Technologies 🛠️
- **Java** (23)
- **Spring Boot** (3.4.1)
- **PostgreSQL** (17)
- **Firebase Account**
- **Postman** (for testing APIs)
---
## Installation 🏗️
### Step 1: Set Up PostgreSQL 🗃️
#### 1. Install PostgreSQL
- **Windows**:
- Download the installer from the [official site](https://www.postgresql.org/download/).
- Follow the installation instructions.
- Set up a password for the `postgres` user during installation.
- **Linux**:
```bash
sudo apt update
sudo apt install postgresql postgresql-contrib
```
- **macOS**:
```bash
brew install postgresql
```
#### 2. Start PostgreSQL Service
- **Windows**: Use **pgAdmin** or start the service from the services tab.
- **Linux/macOS**:
```bash
sudo service postgresql start
```
#### 3. Create a Database
- Access the PostgreSQL shell:
```bash
psql -U postgres
```
- Create a database and tables using the script in the `init-db` folder:
```postgresql
CREATE DATABASE "Auth"
WITH OWNER = auth ENCODING = 'UTF8';
```
- Exit the shell:
```sql
\q
```
### Step 2: Set Up Firebase 🔥
#### 1. Create a Google Account
#### 2. Create a Firebase Account
- Go to [Firebase Console](https://console.firebase.google.com/).
- Log in with your Google account and create a new Firebase project.
#### 3. Enable Authentication 🔑
- Navigate to the **Authentication** section.
- Enable the desired authentication providers (Google, Microsoft, Apple, Facebook).
#### 4. Generate Firebase Admin SDK 🌐
- Go to **Project Settings** > **Service Accounts** and generate a new private key.
- Download the **JSON** file and place it in the project's `resources` folder.
---
## Running the Project ⚡
### 1. Clone the Repository
```bash
git clone
cd
```
### 2. Update Configuration 🛠️
Update the `application.properties` or `application.yml` file:
```properties
spring.application.name=firebase-authentication-api
server.servlet.context-path=/auth
spring.datasource.url=jdbc:postgresql://localhost:5432/Auth
spring.datasource.username=auth
spring.datasource.password=auth
spring.jpa.hibernate.ddl-auto=update
security.jwt.secret-key=
```
### 3. Build and Run 🚀
- **Using Maven**:
```bash
mvn spring-boot:run
```
- **Using Docker (Optional)**:
```bash
docker build -t springboot-firebase .
docker run -p 8080:8080 springboot-firebase
```
---
## API Usage 📡
### API Testing with Postman 🛠️
This project comes with a **Postman collection** inside **assets/postman** to easily test the API endpoints. You can import the `agentnovax-api-auth-springboot-firebase.postman_collection` along with `agentnovax-api-auth-springboot-firebase-IN_local.postman_environment` into your **Postman** application to start testing the authentication flows.
### How to Use the Postman Collection
1. **Download the Postman Collection**:
Download the `agentnovax-api-auth-springboot-firebase.postman_collection` from the repository.
2. **Import into Postman**:
Open Postman and click on the "Import" button on the top left. Select the downloaded collection file and import it into Postman.
3. **Set Up Environment**:
Collection includes an environment file `agentnovax-api-auth-springboot-firebase-IN_local.postman_environment`, import it into Postman to configure variables such as `HOST`, `CONTEXT` and `DOMAIN`. This will allow you to test the endpoints efficiently.
4. **Test API Endpoints**:
Once imported, you can start testing the **login** endpoint provided by the API. Make sure to provide the correct `email` and `password` in the pre-request script for login.
This collection simplifies testing the API without needing to manually craft requests and responses.
---
## Adding Authentication Providers 🌍
### Google Authentication
- Go to Firebase Console > **Authentication** > **Sign-in Method**.
- Enable **Google** and provide the OAuth 2.0 client ID.
### Microsoft Authentication
- Enable **Microsoft** in Firebase Console and provide OAuth credentials from **Azure Portal**.
### Apple Authentication
- Set up **Apple** authentication with the credentials from your **Apple Developer account**.
### Facebook Authentication
- Enable **Facebook** authentication and provide the credentials from **Facebook Developer Console**.
---
## Contributions ✨
We welcome contributions! Feel free to **open a pull request** or raise an **issue** for enhancements or bug fixes.
---
## Additional Notes 📋
- **Testing**: Use tools like **Postman** or **cURL** to test API endpoints.
- **Scaling**: Consider containerization with **Docker** for consistent deployment across environments.
- **Providers**: Refer to the Firebase documentation for detailed setup for other authentication providers.
- For more information, check out the [Spring Boot Documentation](https://spring.io/projects/spring-boot) and [Firebase Authentication Docs](https://firebase.google.com/docs/auth/).
---
## License 📄
Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
---
- ## 📬 Stay Connected
- Website: [AgentNovaX Platform](https://agentnovax.com)
- Social Media:
- [YouTube](https://www.youtube.com/@agentnovaxp)
- [Instagram](https://www.instagram.com/agentnovax/)
- [X (formerly Twitter)](https://x.com/agentnovax)
- [Facebook](https://www.facebook.com/profile.php?id=61571252049491)
- [GitHub](https://github.com/agentnovax/)
- [LinkedIn](https://www.linkedin.com/company/agentnovax/)
- [Discord](https://discord.gg/GDPE6YSJ)
---
## NovaLeaf Concept 🌱
**NovaLeaf** is an initiative focused on environmental sustainability, aiming to contribute to a greener planet. Through this initiative, **AgentNovaX** is committed to planting trees, fostering green projects, and encouraging eco-friendly practices among individuals and communities.
- **Plant a Tree, Empower a Community**: For every milestone achieved in our platform, a tree will be planted in a designated area.
- **Green Nova Trees**: These trees represent our growth and commitment to sustainability, and each one is named for the cause it supports.
- **Join the Movement**: Become part of the **NovaLeaf** family and help us plant the future, one tree at a time. 🌳
🌟 **Please consider starring this repository to support the NovaLeaf initiative** 🌟
For more information, visit [NovaLeaf](https://novaleaf.agentnovax.com).
---
## DataFlux 🔄
**DataFlux** provides free tools for data conversion, JSON/YAML beautification, and validation to help developers and data enthusiasts streamline their workflow.
- Tools available: JSON/YAML Beautifiers and Validators, JSON/YAML conversion, Text Compare, JavaScript Validators, and more.
- Visit [DataFlux](https://dataflux.agentnovax.com) to explore our tools and enhance your productivity.
---
## Disclaimer
The **AgentNovaX Assets Repository** is provided "as-is," without warranty of any kind, express or implied. AgentNovaX does not guarantee the accuracy or completeness of the content in this repository. By accessing and using these assets, you agree that AgentNovaX is not liable for any loss, damage, or legal issues arising from the use of these resources. Users are encouraged to review and validate the content independently before applying it to their own projects.