This Java-based Backend For Frontend (BFF) service is designed to seamlessly integrate with the Journeys Single Page Application (SPA), offering robust backend support for frontend operations.
Built using the powerful Spring Framework, this service handles complex request processing with a focus on geographical data management. Key features include:
- Scalable Data Persistence: Leveraging MongoDB Atlas, the service ensures reliable and scalable data storage.
- Geospatial Support: With geographical information at its core, the service utilizes GeoJSON data format, made simple through the geojson4j library, for accurate and efficient handling of location-based data.
- Passkey / FIDO2 Authentication: Supports WebAuthn passwordless login via passkeys.
- Multi-Factor Authentication (MFA): TOTP-based MFA for enhanced account security.
- AI-Powered Features: Integrates Spring AI with Google Gemini (
gemini-2.5-flash) for intelligent journey assistance.
Please find below steps to setup and run application in your workstation.
The service uses MongoDB for persistence and Mailpit for local email testing.
Spring Boot's Docker Compose integration automatically starts all required infrastructure (MongoDB, Mongo Express,
Mailpit)
when the application is run with the dev profile — no manual docker compose up needed.
Make sure you have Docker and Java 21 installed.
- Download Repository
git clone https://github.com/nramc/journey-api.git
- Run Application with spring profile
dev(infrastructure starts automatically)./mvnw spring-boot:run -pl journey-api-web -Dspring-boot.run.profiles=dev
- Local MongoDB can be accessed at http://localhost:9090/ via Mongo Express; Mailpit UI at http://localhost:8025
- To test REST resources,
use IntelliJ Http Client scripts
available in
src/test/resources/http-scripts/directory.
Any contributions you make are greatly appreciated.
If you like the project and have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'feat: Add the AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
- Manually run Prepare Release Workflow with release version "MAJOR.MINOR.PATCH" e.g. 0.0.1
- The Workflow flow creates a new tag with provided release version vMAJOR.MINOR.PATCH e.g. v0.0.1
- The Workflow creates Release as well with release notes and make the release as latest
- As soon as new
Releasecreated, which triggers Release Workflow with release event - The
Releaseworkflow build & test project after checkout - When build successful, creates Docker image and publish it to Docker Hub
- Finally triggers Render webhook for deployment
Sincere Thanks to following open source community for their wonderful efforts to make our life much easier.
- Spring IO - Java Web Framework
- MongoDB - Persistence Layer
- geojson4j - GeoJSON domain types
- Spring AI - AI integration (Google Gemini)
- Spring Rest Doc - Spring REST Doc with Open API support for Swagger UI
- OpenRewrite - Automated source code refactoring
- Docker - Containerization
- Testcontainers - Run containers on-demand for development and testing
- Mailpit - Local email testing
Give a ⭐️ if you like this project!