MAW11-JDN

Description

This project is designed to .... and the main features are ...

Getting Started

Prerequisites

List all dependencies and their version needed by the project as :

• DataBase Engine : SQLite php8.3-sqlite3
  • Make sure to enable the pdo_sqlite extension in your php.ini file
• IDE used :
  • Visual Studio Code (v1.92.2)
• Package manager :
  • Composer v2.7.9
• Packages :
  • Xdebug (v3.3.2)
  • PHPUnit (v9.6.20)
  • [Zend Engine (4.3.11)]
• OS supported :
  • Debian 11 (bullseye)
  • macOS (Sonoma 14.5)
  • Windows (10.22H2)
• Languages :
  • PHP (8.3.11)
• Extensions :
  • EditorConfig for VS Code (v0.16.4)
  • Prettier - Code formatter (v11.0.0)
  • PHP Tools for VSCode (v1.51.15986)

Configuration

1. Install PHP
   1. macOS
   2. Windows
   3. On Debian based distros
2. Install Composer
3. Install Git
4. Install Xdebug

For Git Flow, it depends on which OS you are. If you are using Windows, it's all good, it already comes installed with git. For the others, follow this tutorial.

In this project, we have been using Visual Studio Code as our main IDE.

Deployment

On dev environment

1. Clone the repository and install the required dependencies

git clone https://github.com/CPNV-ES/maw11-jdn.git
cd maw11-jdn
composer install

2. Setup main branch and init Git Flow for the project

git switch main

git flow init

3. Create configuration file

Create the configuration file and edit parameters

cp config/config.example.php config/config.php

4. Setup the database

To create the database you need to run the maw11_jdn.sql script located in the database folder.

5. Run PHP dev server

./run

How to run the tests?

./vendor/bin/phpunit tests/*.php

Directory structure

./maw11-jdn
├── app
│   ├── controllers
│   │   ├── MainController.php
│   │   └── HomeController.php
│   ├── core
│   ├── models
│   └── views
├── composer.json
├── composer.lock
├── config
│   └── config.example.php
├── database
│   └── maw11_jdn.sql
├── docs
│   ├── looper-features.md
│   ├── looper-specs.md
│   └── repo-structuring.md
├── LICENSE
├── public
│   ├── css
│   ├── images
│   │   └── logo.png
│   └── index.php
├── README.md
├── run
└── tests
    ├── DatabaseTest.php
    └── database

Note : if you want the complete structure check this file repo-structuring.md

Collaborate

• Take time to read some readme and find the way you would like to help other developers collaborate with you.

• They need to know:

  • How to propose a new feature (issue, pull request)
  • How to write code
  • How to commit
  • How to use your workflow - GitFlow

License

• MIT License.

Contact

• David : david.dieperink@eduvaud.ch, GitHub
• Julien : julien.schneider@eduvaud.ch, GitHub
• Nathan : nathan.chauveau@eduvaud.ch, GitHub