Readme update

This commit is contained in:
Joey Kimsey
2025-01-27 22:54:56 -05:00
parent bcd73d58f9
commit b1e74f9652

View File

@ -1,31 +1,52 @@
# Tempus Project Core
###### Developer(s): Joey Kimsey
Bedrock is the core functionality used by [The Tempus Project](https://github.com/TheTempusProject/TheTempusProject) a rapid prototyping framework. This Library can be utilized outside of the TempusProject, but the functionality has not been tested well as a stand alone library. # Bedrock
## Developer(s): Joey Kimsey
This library utilizes the MVC architecture in addition to a custom templating engine designed to make building web applications fast and simple. This library utilizes the MVC architecture in addition to a custom templating engine designed to make building web applications fast and simple.
Bedrock is the core functionality used by [The Tempus Project](https://github.com/TheTempusProject/TheTempusProject) a rapid prototyping framework. It provides database support, configuration, base models, and base controller functionality a in addition to a host of other integrated functions.
This Library can be utilized outside of TheTempusProject, but the functionality has not been tested well as a stand-alone library.
**Notice: This Library is provided as is, please use at your own risk.** **Notice: This Library is provided as is, please use at your own risk.**
## Installation and Use ## Installation and Use
The easiest way to use Bedrock in your application is to install and initialize it via composer.
``` The easiest way to use Bedrock in your application is to install it via composer and extend the main app inside of the bin folder.
`Composer.json`
```json
"require": { "require": {
"TheTempusProject/Bedrock": "*", "TheTempusProject/Bedrock": "*",
}, },
"autoload": { "autoload": {
"psr-4": { "psr-4": {
"Bedrock\": "vendor/TheTempusProject/Bedrock" "TheTempusProject\\Bedrock\\": "vendor/thetempusproject/bedrock",
} }
} }
``` ```
If you prefer to handle auto-loading via other means, you can simply clone this repository wherever you need it. Please note, you will need to install and load the [TempusDebugger](https://github.com/thetempusproject/TempusDebugger) library in order to utilize the debug to console options. `app.php`
```php
<?php
namespace MyApp;
use TheTempusProject\Bedrock\Bin\Bedrock;
class MyApp extends Bedrock {
// Stuff and Things
}
?>
```
If you prefer to handle auto-loading via other means, you can simply clone this repository wherever you need it.
### To-Do
### WIP:
- [ ] Expansion of PDO to allow different database types - [ ] Expansion of PDO to allow different database types
- [ ] template stuff should really only be called from template/controllers - [ ] Updates for configs and models to re-build based on a delta model, to make version changes simpler. (Migration system)
- [ ] Update installer to account for updates. - [ ] Implement better uniformity in terms of error reporting, exceptions, logging.
- [ ] Implement uniformity in terms of error reporting, exceptions, logging.