|
| 1 | +# Project Overview |
| 2 | + |
| 3 | +This project is a web application that allows users to manage FAQs. |
| 4 | +It is built using HTML5, CSS, TypeScript, and PHP, and supports various databases for data storage. |
| 5 | +Supported databases include MySQL, PostgreSQL, SQLite3, and MS SQL. |
| 6 | +Supported search engines include Elasticsearch, and OpenSearch. |
| 7 | +Supported web servers include Apache, Nginx, and IIS. |
| 8 | + |
| 9 | +## Folder Structure |
| 10 | + |
| 11 | +- `/phpmyfaq/admin`: Contains the source code for the admin. |
| 12 | +- `/phpmyfaq/`: Contains the source code for the frontend. |
| 13 | +- `/phpmyfaq/src/phpMyFAQ`: Contains the source code for the PHP backend. |
| 14 | +- `/docs`: Contains documentation for the project, including API specifications and user guides. |
| 15 | +- `/tests`: Contains PHPUnit v12 based unittests. |
| 16 | + |
| 17 | +## Libraries and Frameworks |
| 18 | + |
| 19 | +- HTML 5, CSS, TypeScript, Bootstrap, and Bootstrap Icons for the frontend. |
| 20 | +- PHP with Symfony components for the backend. |
| 21 | +- MySQL, PostgreSQL, SQLite3, and MS SQL for data storage. |
| 22 | + |
| 23 | +## Coding Standards |
| 24 | + |
| 25 | +- Use PSR-12 coding standards for PHP code. |
| 26 | +- Use TypeScript coding standards for TypeScript code. |
| 27 | +- Use HTML5 and CSS3 standards for frontend code. |
| 28 | +- Use semicolons at the end of each statement. |
| 29 | +- Use single quotes for strings. |
| 30 | +- Use arrow functions for callbacks. |
| 31 | + |
| 32 | +## UI guidelines |
| 33 | + |
| 34 | +- Application should have a modern and clean design. |
0 commit comments