Quickstart¶

Watch a concise 15-minute walkthrough that highlights key use cases and includes a hands-on microservices demo.

With docker¶

If you are reading this section, then the assumption is that you have docker installed on your machine. The idea is to showcase a sample spring boot application that is using FF4j for feature management. This will help you to understand how to use FF4j in a real world application and also to get a feel of how it works.

1. Run by pulling the latest image from docker hub

   Cammand to run ff4j sample spring boot application

   docker run -p 8080:8080 ff4j/ff4j-sample-springboot2x:1.8.5
   

   Expected output in the terminal

            _____  _____  _____     __ 
    _/ ____\/ ____\/  |  |   |__|
    \   __\\   __\/   |  |_  |  |
     |  |   |  | /    ^   /  |  |
     |__|   |__| \____   /\__|  |
                      |__\______|
   
   Brought to you by FF4j Developments team
   If you like us, consider to give a ⭐ on github, that helps s! https://github.com/ff4j/ff4j/stargazers
   The application should be available on http://localhost:8080
   15:30:17.803 INFO  org.ff4j.sample.Application                        : Starting Application v1.8.5 on 9a94abfcef56 with PID 1 (/app.jar started by root in /)
   15:30:17.810 INFO  org.ff4j.sample.Application                        : No active profile set, falling back to default profiles: default
   15:30:21.827 INFO  org.ff4j.sample.HomeController                     :  + Features and properties have been created for the sample.
   15:30:24.181 INFO  org.ff4j.sample.Application                        : Started Application in 7.275 seconds (JVM running for 8.759)
   

2. Access the application locally at http://localhost:8080/

It's that simple! You have successfully started a sample FF4j spring boot application.

With spring boot¶

If you are reading this section, then the assumption is that you have a spring boot application and you want to integrate FF4j for feature management. The demo showcases a spring boot application that uses ff4j-spring-boot-starter-webmvc and boots the application.

1. Clone the repository

   Command to clone the repository

   git clone https://github.com/ff4j/ff4j-demo.git
   

2. Start the application

   Command to start the application

   cd ff4j-demo/ff4j-sample-springboot2x
   mvn spring-boot:run
   

3. Access the application locally at http://localhost:8080/