Initial commit
This commit is contained in:
Joey Kimsey
423
README.md
423
README.md
@ -1,93 +1,374 @@
|
||||
# TheTempusProject
|
||||
# The Tempus Project
|
||||
|
||||
|
||||
need to make a vs battle for dnd. someone makes a truly broken character, we take the base character and hand it to two people and give them some time to figure out how they would break it
|
||||
|
||||
## Getting started
|
||||
need to track points once a week
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
a huge table tracks points day to day then we add and erase the old data, or move it to historical...
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
## Rapid Prototyping Framework
|
||||
|
||||
## Add your files
|
||||
### Developer(s): Joey Kimsey
|
||||
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
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.
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://170-187-142-254.ip.linodeusercontent.com/the-tempus-project/thetempusproject.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
**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.
|
||||
|
||||
## Integrate with your tools
|
||||
Currently I am in the process of testing all the systems in preparation for the first production ready release. The beta is still on-going. If you would like to participate or stay up to date with the latest, you can find more information at: https://TheTempusProject.com/beta
|
||||
|
||||
- [ ] [Set up project integrations](https://170-187-142-254.ip.linodeusercontent.com/the-tempus-project/thetempusproject/-/settings/integrations)
|
||||
## Features
|
||||
|
||||
## Collaborate with your team
|
||||
|
||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
|
||||
## Test and Deploy
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
|
||||
***
|
||||
|
||||
# Editing this README
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
|
||||
## Suggestions for a good README
|
||||
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
A User management system with groups, permissions, preferences, registration, and recovery. (All Controlled dynamically via our plugin interface)
|
||||
A Plugin system that allows plug-and-play functionality for a huge number of features.
|
||||
Compatibility with both Apache and NGINX.
|
||||
Built with Bootstrap with a focus on mobile compatibility.
|
||||
Incredibly easy to set-up, deploy, and develop with.
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
Preferred method for installation is using composer.
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
### Manually
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
### Docker
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
### Composer
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
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.
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
#### Apache
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
#### NGINX
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
#### Docker-Compose
|
||||
|
||||
If you have any trouble with the installation, you can check out our FAQ page on the wiki for answers to common issues.
|
||||
|
||||
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.
|
||||
|
||||
**Do not forget to remove install.php once you have finished installation!**
|
||||
|
||||
#### Currently being developed
|
||||
|
||||
- [ ] Adding documentation
|
||||
- [ ] Unit tests
|
||||
|
||||
#### Future updates
|
||||
|
||||
- [ ] Expansion of PDO to allow different database types
|
||||
- [ ] Update installer to account for updates.
|
||||
- [ ] 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
|
||||
xlarge
|
||||
large
|
||||
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
|
||||
|
||||
|
||||
|
||||
// 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
|
||||
// document, fix, and remove @TODO's where possible
|
||||
Search for cuss words, they make you look stupid
|
||||
fuck
|
||||
shit
|
||||
dam
|
||||
damm
|
||||
damn
|
||||
god
|
||||
ass
|
||||
cunt
|
||||
bitch
|
||||
ffs
|
||||
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.
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
|
||||
Reference in New Issue
Block a user