|
1 |
| -# Velox MVA Framework |
| 1 | +# Velox Server |
2 | 2 |
|
3 |
| -Velox is intended as a streamlined client/server data retrieval and communication platform for websites and progressive |
4 |
| -web apps. While designed mainly for a LAMP backend, Velox also wraps SQL Server and ODBC connections into a single |
5 |
| -platform-agnostic class structure that eliminates the need to juggle syntax when using multiple data sources. Velox is |
6 |
| -comprised of both front end and back end components, designed to communicate with each other over AJAX, but decoupled in |
7 |
| -such a way that each can be used independently if necessary. Used as a whole, Velox simplifies development by |
8 |
| -implementing a CRUD interface on the front end and automating the data flow up to and back from the back-end database. |
9 |
| -The client-side component communicates with the server-side component by way of an API endpoint that parses the request |
10 |
| -and dynamically includes the appropriate query definition file, which can be set up using the provided template with only |
11 |
| -the sample SQL replaced. This allows the back-end developer to work almost entirely in SQL and build the necessary |
12 |
| -datasets to pass to the front-end with minimal effort. This repository contains the server-side component of this |
13 |
| -framework. |
| 3 | +Velox Server is the primary server-side component of the [Velox MVA](https://github.com/KitsuneTech-com/Velox-MVA) |
| 4 | +framework. It provides a platform-agnostic class structure that eliminates the need to juggle syntax when accessing |
| 5 | +multiple data sources, including MySQL/MariaDB, Microsoft SQL Server, and ODBC-compatible sources. The Model class |
| 6 | +also allows for additional data caching, manipulation, and export of the retrieved datasets. |
14 | 7 |
|
15 | 8 | ## Requirements
|
16 |
| -The eventual goal is to make this framework as portable and platform-agnostic as possible. At this early stage in |
17 |
| -development, however, the focus is currently on a LAMP server architecture. The particular requirements for the |
18 |
| -server-side component are as follows: |
| 9 | +Velox Server has been built to be as portable and platform-agnostic as possible, though it has yet to be tested on |
| 10 | +non-POSIX systems. (Users are welcome to try this at their own risk, and feedback in such cases is welcome.) The |
| 11 | +minimum software requirements for Velox Server are as follows: |
19 | 12 |
|
20 | 13 | * PHP 8.0.2+, with Composer 2.0+
|
21 | 14 | * One or more of the following extensions, depending on the database engine to be used:
|
22 | 15 | * MySQL / MariaDB: either mysqli or pdo_mysql
|
23 | 16 | * Microsoft SQL Server: either sqlsrv or pdo_sqlsrv (note: either of these require the Microsoft ODBC Driver for SQL
|
24 | 17 | Server.)
|
25 | 18 | * ODBC: either odbc or pdo_odbc, along with the necessary drivers for the desired connection
|
26 |
| - * The xmlwriter extension, if the server-side component is to be used without the client-side component and XML output |
27 |
| - is needed |
28 |
| -* A web server that supports PHP server-side scripting (Apache 2.4+ is specifically supported, but NGINX, IIS, and others |
29 |
| - may work as well) |
| 19 | + * The xmlwriter extension, if Velox Server is to be used standalone and XML output is needed |
| 20 | +* Certain forms of output may require a web server that supports PHP server-side scripting (Apache 2.4+ is specifically |
| 21 | + supported, but NGINX, IIS, and others may work as well) |
30 | 22 |
|
31 | 23 | ## Note for Developers and Potential Contributors
|
32 |
| -This framework is still in development, and is not at present suitable for integration into any serious project. When |
33 |
| -ready, it will be released under a permissive open-source license (which specific license is still under consideration), |
34 |
| -without cost. Because this is being developed for common use, any feature requests are welcome and will be considered on |
35 |
| -their merits. Feel free to drop any such requests in Issues or Discussions. |
36 |
| - |
37 |
| -## Disclaimer |
38 |
| -As mentioned in the note above, this is under active development, and as such there is absolutely no warranty of fitness |
39 |
| -of use. If you use any part of this framework prior to official release, you do so at your own risk. Anyone who |
40 |
| -contributes code to this project does so without assuming any liability for damages that might result from its use prior |
41 |
| -to official release. |
| 24 | +As an open source project, the Velox MVA and its components (including Velox Server) have been developed for common |
| 25 | +use, and any feature requests are welcome and will be considered on their merits. Feel free to drop any such requests |
| 26 | +in Issues or Discussions. Those wishing to make contributions to the code base should read the |
| 27 | +[Contribution Guidelines](https://github.com/KitsuneTech-com/Velox-Server/blob/main/CONTRIBUTING.md) for more details |
| 28 | +on how to do so. |
0 commit comments