Skip to content

A Symfony project using french government API to find companies owners given their name and zip code

License

Notifications You must be signed in to change notification settings

ThibaultLassiaz/CEOInspector

Repository files navigation

CEO Inspector

PHP Version PHPUnit Version Symfony Version Symfony CLI Version

The Principle

The main purpose of this application is to provide the first and last names of company owners by providing the company name and zip code.

The application comes with a simple twig frontend that allows you to upload files on a dropzone. Check file completion, download and delete files.

We're using this French government open API to do it

How to use

Create the database

php bin/console doctrine:migrations:migrate

Launch the web server

symfony server:start

or host it on you domain, it comes with an Apache dependency and preconfigured .htaccess

Once the server is started you can check on your localhost or on your web domain ex : https://my-domain.com

Start the workers

In order to start the workers you'll have to start both file and company queues using Symfony Messenger Bundler

Start file worker to consume file messages

php bin/console messenger:consume --time-limit=55 file

Start company worker to consume file messages

php bin/console messenger:consume --time-limit=55 company

Note that the government API can handle 7 requests per seconde maximum, so I recommend to run maximum 5 to 7 worker max at the same time

Input format

The application currently only support xlsx files, as it was created to handle this format and specified columns

You can find a file example here

Dev

Static analysis

composer run phpstan

Linter

composer run linter

Unit tests

composer run unit

About

A Symfony project using french government API to find companies owners given their name and zip code

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published