eclipsefdn-cve-api

This API fetches internal CVE data

Getting started

Requirements

• Docker
• mvn
• make
• yarn
• Java 11 >

Setup

Before running the application, some setup is required. The initial setup of this server can be started by running the command make setup which will instantiate the secrets file. To finish the setup, open the secrets file and add values to the missing fields before starting the server. The missing fields are primarily parameters used in the fetching of CVE data from GitLab and GitHub. Once the setup is finished you should be able to start the server through docker or using the live coding dev-mode.

Build and Start Server

make compile-start

Build and Start Server Using Stubbed Data

A version of the above server using stubbed data

make compile-start-stubbed

Live Coding Dev Mode

The live-coding dev mode uses stubbed data

make dev-start

Generate Spec

make generate-test-resources

Running Tests

mvn test

Render a Live UI Preview of the API Spec

make start-spec

Contributing

1. Fork the eclipsefdn-cve-api repository
2. Clone repository git clone https://gitlab.eclipse.org/[your_eclipsefdn_username]/eclipsefdn-cve-api.git
3. Create your feature branch: git checkout -b my-new-feature
4. Commit your changes: git commit -m 'Add some feature' -s
5. Push feature branch: git push origin my-new-feature
6. Submit a merge request

Declared Project Licenses

This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

SPDX-License-Identifier: EPL-2.0