Ninjanalysis
Security in software development is a major concern in the field of computing. While artificial intelligence has made significant advances, human expertise remains essential. To facilitate this expertise, various static code analysis tools have been developed, offering valuable assistance.
This project aims to make the most of these tools and provide a comprehensive and user-friendly application. To achieve this, we utilize tools such as PHP Security Checker, PHPStan, and Composer Audit.
To get started with this project, follow these steps:
Clone the project: git clone https://github.com/it-akademy-students/hackathon-2024-groupe6.git Install dependencies: composer install and npm install Configure the Environment: Copy the .env.example file to .env and configure the database information and other necessary parameters. Install PHP dependencies with composer install Generate Application Key: php artisan key:generate Symlink storage : php artisan storage:link Migrate Database: php artisan migrate Launch the Application: php artisan serve for the backend and npm run dev for the frontend. Run the command:
which phpand copy and paste the output of the command into the first line of the vendor/bin/phpstan file as in this example #!/opt/homebrew/bin/php
Before you begin working with this project, ensure that you have the following prerequisites installed and configured:
PHP - Ensure that PHP is installed on your machine. You can download it from the official PHP website. Composer - Composer is a dependency manager for PHP. Install Composer globally on your machine by following the instructions on the Composer website. Node.js and npm - The project uses Node.js for frontend development. Install Node.js and npm to manage JavaScript packages. You can download them from the Node.js website. Vue.js - The frontend is developed using Vue.js. Familiarize yourself with Vue.js by referring to the official documentation. Laravel - Laravel is the PHP framework used for the backend. Make sure to have Laravel installed. You can install it globally using Composer: composer global require laravel/installer MySQL - MySQL is the chosen database system for this project. Install and configure MySQL on your machine. Git - Git is used for version control. Install Git to clone and contribute to the project. You can download it from the Git website. [Your IDE/Code Editor] - Use a code editor or integrated development environment (IDE) of your choice. Some popular options include Visual Studio Code, PhpStorm, or Sublime Text.
A step by step series of examples that tell you how to get a development environment running
Clone the repository with git clone https://github.com/it-akademy-students/hackathon-2024-groupe6.git Install JavaScript dependencies with npm install Configure your .env file with your database settings Generate a Laravel application key with php artisan key:generate Migrate the database with php artisan migrate
You can run different types of tests to ensure the quality and reliability of the system.
To run the tests, follow these steps:
Unit Tests: Unit tests verify individual functions of the code to ensure they work correctly. To run unit tests, use the following command: php artisan test
Feature Tests: Feature tests verify if the system's features work as expected. Use the following command to run feature tests: php artisan test --feature
Integration Tests: Integration tests verify if different parts of the system work correctly together. Run integration tests with the following command: php artisan test --integration
For the versions available, see the (https://github.com/it-akademy-students/hackathon-2024-groupe6.git
See also the list of contributors https://github.com/it-akademy-students/hackathon-2024-groupe6.git who participated in this project.
If you need help or have a general question, contact e.ducrest@it-students.fr