What if I want to contribute ?

How to contribute ?

Feel free to fork this repository and make your own contribution, open pull requests, or create issues.

Warning

Important advisory notes before you start

Please note that this documentation is incomplete as it is still in work, you may find "TODO" withing it.

I wrote this section to help you get started with the project, but it is not a complete reference. You may have to do your own research to understand all the code sections of the project.

If you need help, please feel free to contact me at gael.lejeune@capgemini.com, lejeune.gael@free.fr or on Github.

How does this fork work ?

General structure

The project is divided into two main parts:

• The Docker repository, which contains the code that is used to build the Docker image.
• The application repository, which contains the code that is used to run the application.

This two repositories are designed to work together. See more in the docker installation section.

Code structure

The application uses Flask as a web framework and SQLAlchemy as a database.

It uses the following structure:

📦opencve
 ├── 📂api
 ├── 📂checks
 ├── 📂commands
 │    └── 📂imports
 ├── 📂controllers
 ├── 📂migrations
 │    └── 📂versions
 ├── 📂models
 ├── 📂static
 │    ├── 📂css
 │    ├── 📂fonts
 │    ├── 📂img
 │    └── 📂js
 ├── 📂tasks
 ├── 📂templates
 │    ├── 📂admin
 │    ├── 📂emails
 │    ├── 📂errors
 │    ├── 📂flask_user
 │    ├── 📂profiles
 │    ├── 📂report
 │    ├── 📂_includes
 │    └── 📂_welcome
 │         └── 📂css
 ├── 📂views
 ├── 📜admin.py
 ├── 📜app.py
 ├── 📜cli.py
 ├── 📜configuration.py
 ├── 📜constants.py
 ├── 📜context.py
 ├── 📜default.cfg
 ├── 📜extensions.py
 ├── 📜forms.py
 ├── 📜settings.py
 ├── 📜utils.py
 ├── 📜VERSION
 └── 📜__init__.py

Info

You can find the official documentation of python-flask layout here.