This application uses Spring Boot and MongoDB.
You can find Spring Boot documentation here: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/ MongoDB documentation can be found here: https://docs.mongodb.com/

Getting Started

Before you begin development on this project you will need to meet these prerequisites in your development environment.

• Install the listed FLARE projects as they are dependencies of the FLAREclient (Branches listed are as of December 17 2018. This will updated as branches are merged, and the application is closer to delivery.)

  • javaTAXII2 - develop branch
    • To make sure this is properly installed as a dependency for the client run a mvn install or mvn install -DskipTests to save some time.
  • FLAREutils - master branch
    • To make sure this is properly installed as a dependency for the client run a mvn install or mvn install -DskipTests to save some time.

• Install the following development tools in order to run the client locally for development.

  • Docker to house the Mongo instance that interacts with the client during development.

• You will need our admin certificate to be able to hit the api endpoints within the client found here. Get the password from a teammate to unzip it.

Docker

The containerization of FLAREclient-UI requires that you have the FLAREclient-Java repository locally.

1. Make sure the FLARECLIENT_JAVA_LOCATION value is correct in FLAREclient-UI/build.sh.
2. Build the docker image ./build-intergrated-image.sh. This will build the FLAREclient-Java jar file, as well as the FLAREclient-UI front end.
3. Run the docker image with ./run.sh.

Running FLAREclient Locally

After installing all of the prerequisites, you should be able to now run FLAREclient locally. To begin you will need to run the MongoDB instance in docker and expose port 27017. If this is your first time setting up the client, run

docker run -p 127.0.0.1:27017:27017 -e MONGODB_ADMIN_PASSWORD=12qwaszx@#WESDXC --name flaremongodb -d centos/mongodb-36-centos7:latest

Once it has been installed, to run it again use:

docker start flaremongodb

...

Building

To build the FLAREclient application run:

mvn clean package

To ensure everything worked, run:

java -jar target/*.jar

Then navigate to http://localhost:8081 in your browser.

Testing

To launch your application's tests, run:

mvn clean test

Using Docker to simplify development (optional)

You can use Docker to improve your FLAREclient development experience. A number of docker-compose configuration are available in the src/main/docker folder to launch required third party services.

For example, to start a mongodb database in a docker container, run:

docker-compose -f docker/mongodb.yml up -d

To stop it and remove the container, run:

docker-compose -f docker/mongodb.yml down

You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:

mvn clean package docker:build

Then run:

docker-compose -f docker/app.yml up -d

For more information about Docker refer to https://docs.docker.com/ For more information about Docker Compose refer to https://docs.docker.com/compose/