From 55a725cd9e14e957f9c721b60ded597f1dc475b6 Mon Sep 17 00:00:00 2001 From: Joey Kimsey Date: Thu, 15 Aug 2024 01:30:55 -0400 Subject: [PATCH] readme and license updates --- LICENSE | 8 +- README.md | 382 +++++++++++------------------------------------------- 2 files changed, 81 insertions(+), 309 deletions(-) diff --git a/LICENSE b/LICENSE index c32ae1d..bb6e417 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,10 @@ -MIT License +Copyright (c) 2024-present Joey Kimsey -Copyright (c) 2024 Joey Kimsey +Portions of this software are licensed as follows: + +* All content residing under the "app/" directory of this repository, excluding "app/plugins/"; is licensed under "Creative Commons: CC BY-SA 4.0 license". +* All third party components incorporated into The Tempus Project Software including plugins are licensed under the original license provided by the owner of the applicable component. +* Content outside of the above mentioned directories or restrictions above is available under the "MIT Expat" license as defined below. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 945470e..8efecae 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ # The Tempus Project -## Rapid Prototyping Framework +_Rapid Prototyping Framework_ -## Developer(s): Joey Kimsey +__Developer(s):__ + +* __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. @@ -11,14 +13,7 @@ I am working very hard to ensure the system is safe and reliable enough for me t ## Table of contents -* [Find Us](#find-us) -* [Features](#features) -* [Installation](#installation) -* [Contributing](#contributing) -* [Community](#community) -* [Versioning](#versioning) -* [Creators](#creators) -* [Copyright and license](#copyright-and-license) +[[_TOC_]] ## Find Us @@ -26,6 +21,10 @@ I am working very hard to ensure the system is safe and reliable enough for me t * [Packagist](https://packagist.org/users/joeyk4816/packages/) * [GitLab](https://git.thetempusproject.com/the-tempus-project/thetempusproject) +## 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. + ## Features - A Plugin system that allows plug-and-play functionality @@ -41,185 +40,89 @@ I am working very hard to ensure the system is safe and reliable enough for me t ## Installation -Preferred method for installation is using composer. Special attention has been given to use without composer and more information is included below. +The preferred method for installation is [Composer](#composer) but special attention has been given to installation and usage [without Composer](#composer). ### Composer The simplest method to start a new project is to use composer to create a new project and automatically clone all the necessary files: +#### via create-project + ``` composer create-project thetempusproject/thetempusproject test-app ``` -1. Clone the directory to wherever you want to install the framework. -2. Open your terminal to the directory you previously cloned the repository. -3. Install using composer: -`php composer.phar install` -4. Open your browser and navigate to install.php (it will be in the root directory of your installation) -5. When prompted, complete the forms and complete the process. +#### via clone & install -[![Slack](https://bootstrap-slack.herokuapp.com/badge.svg)](https://bootstrap-slack.herokuapp.com) +1. Clone the directory to wherever you want to install the framework. +`git clone https://git.thetempusproject.com/the-tempus-project/thetempusproject.git ` +1. Open your terminal to the directory you previously cloned the repository. +`cd ` +1. Install using composer: +`php composer.phar install` ### Manually -### Docker +1. Clone the directory to wherever you want to install the framework. +`git clone https://git.thetempusproject.com/the-tempus-project/thetempusproject.git ` +1. Open your terminal to the directory you previously cloned the repository. +`cd /` +1. Clone the dependency directories to the vendor/ folder. +``` +`cd vendor/` +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/hermes.git hermes +git clone https://git.thetempusproject.com/the-tempus-project/houdini.git houdini +``` -#### Apache +__Note:__ The autoloader should automatically detect and use the dependencies, but they need to be sorted into the folders ans shown above. -#### NGINX -#### Docker-Compose +## Docker -If you have any trouble with the installation, you can check out our FAQ page on the wiki for answers to common issues. +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. -If you would like a full copy of the project with all of its included dependencies you can find it at https://github.com/TheTempusProject/TempusProjectFull -Please note this repository is only up to the latest _stable_ release. Please continue to use composer update to get the latest development releases. +You will need docker installed on your system then you can either download the latest images from DockerHud: -**Do not forget to remove install.php once you have finished installation!** +``` +docker pull thetempusproject/ttp-apache +docker pull thetempusproject/ttp-nginx +``` -#### Currently being developed +Or you can build your own images from this repository. More information can be found in the included README files: + +* [Apache Image](docker/ttp-apache/README.md) +* [Nginx Image](docker/ttp-nginx/README.md) + +### Docker-Compose + +The Docker stack included here will build new versions of the nginx and apache webserver and launch them in individual containers. It will also create 2 more containers; one for php, and one for phpmyadmin. + +``` +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. + +## Contributing + +TheTempusProject is an open source project and welcomes community contributions. Please refer to the [Contributing file](CONTRIBUTING.md) for more details. + +## License + +See the [LICENSE](LICENSE.md) file for licensing information as it pertains to files in this repository. + +## Currently being developed - [ ] Adding documentation -- [ ] Unit tests +- [ ] Unit testing -#### Future updates +## Future updates - [ ] Expansion of PDO to allow different database types -- [ ] Update installer to account for updates. +- [ ] Update installer to account for database deltas, allowing easy updating. - [ ] Implement uniformity in terms of error reporting, exceptions, logging. -- [ ] The templating system has gotten too large and needs to be split into its own repo - -TTP ToDo: - -need to integrate new plugins for some moved features - canary - comments - members - messages - Split inbox and outbox apart - split messages from usercp - redirects - -need to make sure all 'use ' statements are updated to new repo names - - namespace TempusDebugger; => namespace TheTempusProject\Canary; - namespace TheTempusProject\Houdini; => namespace TheTempusProject\houdini; - namespace TheTempusProject/TempusTool; => namespace TheTempusProject\Overwatch; -need a mechanism for handeling config/constants.php in each plugin - migrate all 'secondary' constants (constants not used in the default execution of the application) to plugin folders - -Perform final F & R for: -"tpc" - - - - need better handeling around blog filters like month and day - -split profile from usercp - - -need a way to secure the api -need a standard way to do apis -need a way to show parts conditionally like {@if} - need - if - else - elseif -need a way to show something conditionally if a plugin is enabled - like {@enabled:comments} - {comments} - {@enabled} - -https://css-tricks.com/drag-and-drop-file-uploading/ - -https://www.smashingmagazine.com/2018/01/drag-drop-file-uploader-vanilla-js/ - - - - - -need to merge both autoloaders into the same one under bin -need to be able to install multiple database tables for the same plugin - - -rename default.js and .css to main.js/css -fix where i moved those to the app/css and app/js folders - - - -make a new template repo/dependency -make a new Debug repo/dependency -Fix the plugin -fix the console logger - -add the ability to include js files -add the ability to include css files as needed - - chat should include a config for the refresh timer - - - - -and better error handeling for models and plugins -need to make a singular list function to remove or combine these: - listGroupsSimple - listPosts - - - - - - -i need to move everything moderator relateed to comments -i also need to make sure that moderators can actually moderate - - - - - -the get form html thing should work perfectly with the database array to create hella simple to generate forms for anything - - - - - - - - - -we are not doing anything with requiredPlugins - - -comments and blog are being manually added in the admin dashboard, this could be a problem when they are disabled - - - - - - - - - - - -removed from blog filter -commentCount - - - -need to address the error handler just failing to work - -and the exception handler picking up random errors - - -need to revisit all of the form checking and make sure it is apparent to the user when and how they mess something up. - - -many pages are missing descriptions, need to add them - - -https://jsonapi.org/format/ - need a way for the template system to: switch between the meta-header content types for the sharing info @@ -228,68 +131,18 @@ need a way for the template system to: etc need better checking around title, meta-image, and descriptions prevent accidently feeding bad images or text to these fields - need to manages js and css includes better, and incorperate it into templating system - - - - - - - - - - - - -the get timezone getdate gettime format functions all need to be migrated to app, stored as static vars and refactored -in core, am i using htaccess.html or nginx.html anywhere, if not, change them to .example -Routes -> getHost is using a terrible conditional for docker hosts, need to improve -Need to test all the filters for the editor stuff -need the ability for the autoloader to accept specific file name associations -needs a require_all -need to re-namespace all classes and functions -some classes need to be converted to non-static -some functions need to be converted to more static -run from the command line - -initiated // is in so many controllers, i def want this removed initialized -tempus_project.php - test running commands from cli -if we move install.php to the bin, it will be unaccessible to the web server?? - if its unaccessible except theough the index.php router, we don't need to delete it because its unaccessible again -can i use submodules? -errors should be able to be customized - if its in the app -should add more logging, esp for admin actions -need to add self::$pageDescription to many pages -man, messages is hot garbage, def needs a rework -need a mechanism to add listeners and events -ability to restore backups of perms prefs and configs -if your controller has no index method, you're just SOL - a blank page is called and no method is loaded -Warns should be for failed checks -add a check for having write access to the config folder and the uploads folder -and whatever is going to be needed to the plugin downloading - - some configs have been removed and need to be accounted for - Unused: - --------------------------- - Config::getValue('bugReports/sendEmail') - Config::getValue('bugReports/emailTemplate') - Config::getValue('feedback/sendEmail') - Config::getValue('feedback/emailTemplate') - Config::getValue('uploads/files') - Config::getValue('uploads/images') - Config::getValue('uploads/maxFileSize') - - -after all changes are pushed up and available, docker needs to be tested and updated - when using composer, the composer page is populated and correct - -the config step of install should be checking the db creds +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 +### Release Checklist +===================== +- [] Spell check every file. +- [] All documentation must be reviewed for accuracy. +- [] If a new year has passed, ensure the year has been updated where applicable. +- [] 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 cross refrence the configs from core and ttp // ensure the resources folder is current @@ -308,88 +161,3 @@ Search for cuss words, they make you look stupid wtf - - -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 - -// this can be used for the tempus project -composer create-project laravel/laravel example-app - -# Release Checklist - -===================== -- [] Spell check every file. -- [] All documentation must be reviewed for accuracy. -- [] If a new year has passed, ensure the year has been updated where applicable. -- [] If default permissions, preferences, configs, base classes or models have been updated, update resources accordingly. -- [] - - - - - - - - - - - - - -namespace TempusDebugger; => namespace TheTempusProject\Canary; - - - - - - - - - - -need to make sure a template loader can be called and still use the default template file, IE always add these CSS or JS resources. - - - - -discord bot that shares updates on your party from the site -maybe a summary after each session -warning that time is coming up -changes made to anything -D&D news - - - - -is it possible to store a campaigns state on the blockchain? - - - - -keeping this as a repository for podcasts would get more people to check it out -same for youtube - -people love sharing their resources, so make it EASY to find podcasts, and youtube channels, and etsy stores, and give people a place to share it with their groups - -try and earn commisions from this and do featured XYZ every x days or weeks or whatever - -have different "kinds" of dice to portray on the dice roll page - -maybe spinners instead of conventional die - -maybe weird health potions for D4's - - - - - - - - - - -What is my goal here? - -I would like to play Dungeons and Dragons once a week with my friends. In an ideal world, I would DM this game and spend all week building tools for us to use that I then put on a website which sells memberships to other players so they can use the tools too. -