Skip to content

alexandre-touret/trainee-bootcamp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

This bootcamp/workshop aims to develop the following skills:

  • Git Configuration management
  • Design
  • Backend development
  • Front end development
  • Elasticsearch management & configuration

The use case

During this workshop, we will code a full search engine. It will enable searching in a CVE repository.

Architecture of the solution

Context

Here is the high level design:

context

Explanation

The system is reachable by a web interface enabling searching into a CVE search engine.

We can search with any criteria we want.

Containers

containers

Explanation

Search Engine

It's based on ElasticSearch.

You can use it through Docker. Check out this documentation.

CVE Importer Batch

This program aims to:

  1. Download latest CVE export from https://www.cve.org/Downloads
  2. Store them into ElasticSearch through its API

Backend

This program aims to

  1. Expose APIs to search CVEs from ElasticSearch

Front end

This program aims to: 2. Provide a GUI to reach the API.

Workshop

Important

Please submit your code in a dedicated branch through a Pull Request

Step 1

Design

  1. Start listing all the use cases
  2. For each use case follow the agenda below

Use case documentation

Here is how to describe a use case:

  1. Textual description
  2. Use case schema
  3. Activity diagram of the use case and a textual description of all the implied activities
  4. Sequence diagram

[!INFO] You can write a document following into the docs/step1 folder based on this template You can them write your documentation using the markdown format For your diagrams, include them as an image. You can also use PlantUML (not required)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published