the-tempus-project/thetempusproject
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme Updates

Browse Source
This commit is contained in:
Joey Kimsey
2024-08-15 01:36:35 -04:00
parent 55a725cd9e
commit b658614ce8
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -4,11 +4,11 @@ _Rapid Prototyping Framework_
__Developer(s):__ __Developer(s):__
* __Joey Kimsey__ - _Lead Developer_ - __Joey Kimsey__ - _Lead Developer_
The aim of this project is to provide a simple and stable platform from which to easily add functionality. The goal being the ability to quickly build and test new projects with a lightweight ecosystem to help. The aim of this project is to provide a simple and stable platform from which to easily add functionality. The goal being the ability to quickly build and test new projects with a lightweight ecosystem to help.
**Notice: This code is in _still_ not production ready. This framework is provided as is, use at your own risk.** **Notice: This code is in _still_ not production ready. This framework is provided as is, use at your own risk.**\
I am working very hard to ensure the system is safe and reliable enough for me to endorse its widespread use. Unfortunately, it still needs a lot of QA and improvements. I am working very hard to ensure the system is safe and reliable enough for me to endorse its widespread use. Unfortunately, it still needs a lot of QA and improvements.
## Table of contents ## Table of contents
@ -23,7 +23,7 @@ I am working very hard to ensure the system is safe and reliable enough for me t
## Summary ## Summary
The Tempus Project is a PHP application utilizing the MVC pattern to serve up simple pages and api's with minimal effort. It requires a mysql database to function and is designed to run equally well with nginx or apache powering the webserver. Most of the core functionality is developed in house and provided through dependencies. At this time, the frontend is driven on bootstrap 3 and FontAwesome for simplicity. The Tempus Project is a PHP application utilizing the MVC pattern to serve up simple pages and APIs with minimal effort. It requires a MySQL database to function and is designed to run equally well with nginx or apache powering the webserver. Most of the core functionality is developed in house and provided through dependencies. At this time, the frontend is driven on bootstrap 3 and FontAwesome for simplicity.
## Features ## Features
@ -69,7 +69,7 @@ composer create-project thetempusproject/thetempusproject test-app
`cd <test-app>/` `cd <test-app>/`
1. Clone the dependency directories to the vendor/ folder. 1. Clone the dependency directories to the vendor/ folder.
``` ```
`cd vendor/` cd vendor/
git clone https://git.thetempusproject.com/the-tempus-project/bedrock.git bedrock git clone https://git.thetempusproject.com/the-tempus-project/bedrock.git bedrock
git clone https://git.thetempusproject.com/the-tempus-project/canary.git canary git clone https://git.thetempusproject.com/the-tempus-project/canary.git canary
git clone https://git.thetempusproject.com/the-tempus-project/hermes.git hermes git clone https://git.thetempusproject.com/the-tempus-project/hermes.git hermes
@ -81,7 +81,7 @@ __Note:__ The autoloader should automatically detect and use the dependencies, b
## Docker ## Docker
To enable quick deployment and collaberation The Tempus Project is distributed with the files to build your own docker images or stack with apache or nginx The included `docker-compose.yml` will load up an entire stack including apache and nginx, as well as a mysql server with phpmyadmin. To enable quick deployment and collaboration The Tempus Project is distributed with the files to build your own docker images or stack with apache or nginx The included `docker-compose.yml` will load up an entire stack including apache and nginx, as well as a MySQL server with phpmyadmin.
You will need docker installed on your system then you can either download the latest images from DockerHud: You will need docker installed on your system then you can either download the latest images from DockerHud:
@ -103,7 +103,7 @@ The Docker stack included here will build new versions of the nginx and apache w
docker-compose -f docker-compose.yml up --build -d --no-cache docker-compose -f docker-compose.yml up --build -d --no-cache
``` ```
__Note:__ If you clones the repository from git, you will need to copy the `docker/.env.example` to `.env` in the root directory and update the contents before proceeding with docker-compose. __Note:__ If you cloned the repository from git, you will need to copy the `docker/.env.example` to `.env` in the root directory and update the contents before proceeding with docker-compose.
## Contributing ## Contributing
@ -111,7 +111,7 @@ TheTempusProject is an open source project and welcomes community contributions.
## License ## License
See the [LICENSE](LICENSE.md) file for licensing information as it pertains to files in this repository. See the [LICENSE](LICENSE) file for licensing information as it pertains to files in this repository.
## Currently being developed ## Currently being developed
@ -130,7 +130,7 @@ need a way for the template system to:
large large
etc etc
need better checking around title, meta-image, and descriptions need better checking around title, meta-image, and descriptions
prevent accidently feeding bad images or text to these fields prevent accidentally feeding bad images or text to these fields
had to remove the tracking pixel that was to be used with the contacts form, this will need to be re- added in a future update had to remove the tracking pixel that was to be used with the contacts form, this will need to be re- added in a future update
had to remove the rest controller, its currently just unused had to remove the rest controller, its currently just unused
@ -144,7 +144,7 @@ had to remove the rest controller, its currently just unused
- [] If default permissions, preferences, configs, base classes or models have been updated, update resources accordingly. - [] If default permissions, preferences, configs, base classes or models have been updated, update resources accordingly.
- [] - []
// need to make notes of other standards as i go to update the contributing document // need to make notes of other standards as i go to update the contributing document
// need to cross refrence the configs from core and ttp // need to cross reference the configs from core and ttp
// ensure the resources folder is current // ensure the resources folder is current
// document, fix, and remove @TODO's where possible // document, fix, and remove @TODO's where possible
Search for cuss words, they make you look stupid Search for cuss words, they make you look stupid