ucscode/user-synthetics

User Synthetics: An open-source PHP framework used for developing robust and scalable web applications.

8.0.1 2024-03-26 23:56 UTC

Requires

• php: >=8.1
• erusev/parsedown-extra: ^0.8.1
• fakerphp/faker: ^1.23
• jasongrimes/paginator: ^1.0
• phpmailer/phpmailer: ^6.8
• symfony/http-foundation: ^6.4
• symfony/routing: ^6.4
• symfony/uid: ^6.4
• symfony/yaml: ^6.4
• twig/html-extra: ^3.8
• twig/twig: ^3.0
• ucscode/domtable: ^2.0
• ucscode/local-storage: ^2.0
• ucscode/pairs: ^3.0
• ucscode/promise: ^1.0
• ucscode/squery: ^3.0
• ucscode/tree-node: ^3.0
• ucscode/uss-element: ^2.0
• ucscode/uss-form: ^3.0
• vlucas/phpdotenv: ^5.6
• webuni/front-matter: ^2.0

Requires (Dev)

• phpunit/phpunit: ^10.5

MIT

• Uchenna Ajah

• framework
• cms
• open-source
• user-synthetics

README

User Synthetics

Modular PHP Framework for Customizable and Extensible Web Applications

Explore the User Synthetics docs »

Introduction

User Synthetics is a powerful and versatile PHP framework designed to simplify the development of customizable and extensible web applications. With User Synthetics, you can create robust platforms tailored to your specific requirements, thanks to its modular architecture and user-friendly interface.

The framework provides a solid foundation, incorporating essential third-party libraries like Bootstrap, Toastr.js, and Bootbox, to empower developers with a comprehensive set of tools for building modern and interactive web applications.

Screenshot

This is a screenshot of Uss Dashboard Module

Features

• Modular Architecture: User Synthetics embraces a modular architecture that allows you to easily extend and customize your application. You can create custom modules to enhance the functionality and tailor the platform to your unique needs.

• Intuitive API: User Synthetics provides an expressive and intuitive API, making it a breeze to develop web applications. The framework's API is designed to streamline development and improve developer productivity.

• Lightweight and Efficient: User Synthetics is built with performance in mind. It offers a lightweight and efficient design that ensures optimal performance, delivering a smooth user experience.

• Essential Classes: The framework includes several built-in classes to facilitate common tasks and reduce development time. These classes include event handling, data storage, HTML table generation, hierarchical menu structures, simplified SQL statements, key-value data storage, and HTML syntax conversion.

• Mini Template Engine: User Synthetics features a mini template engine that simplifies dynamic content replacement within HTML templates. This allows you to easily customize and personalize the user interface of your application.

Getting Started

Follow these steps to get started with User Synthetics:

Using Composer

Use the following command to create a new project:

composer create-project ucscode/user-synthetics my_directory

This will create a new directory named my_directory and install User Synthetics and all its dependencies into it.

Without Composer

1. Clone the repository: git clone https://github.com/ucscode/user-synthetics.git.
2. Extract the clone repository into your server directory.
3. Open your terminal to the server directory and run the following command

composer install

Refer to the User Synthetics documentation for detailed usage instructions and guides.

Updating User Synthetics

After installation, you can update to the latest version of user synthetics using the following command

composer update

Documentation

Comprehensive documentation is available for User Synthetics to assist you in using and extending the framework effectively. The documentation covers various topics, including installation, module development, API references, and best practices. Visit the User Synthetics Documentation to explore the resources.

Contributing

User Synthetics is an open-source project developed with a vision to foster a thriving and collaborative community. Contributions from developers are welcome to make User Synthetics even better.

If you have ideas for new features, bug fixes, or improvements, you can submit a pull requests. Help enhance the framework and make it more powerful and flexible but endeavor to retain it lightweight nature.

Report Issues: If you come across any issues or bugs while using User Synthetics, please expose it by opening an issue in the Issue Tracker. Your feedback is valuable and will help improve the stability and reliability of the framework.

License

User Synthetics is released under the GNU General Public License (GPL) version 3 or later. For more information about, please refer to the LICENSE file.

Acknowledgements

User Synthetics is developed and maintained by ucscode. If you have any questions, suggestions, or need assistance, please feel free to reach out.

Useful PHP Libraries

• jaybizzle/crawler-detect: CrawlerDetect is a PHP class for detecting bots/crawlers/spiders via the user agent and http_from header.

• FakerPHP: Faker is a PHP library that generates fake data for you.