Download the PHP package shirtnetwork/designer-backend-skeleton without Composer
On this page you can find all versions of the php package shirtnetwork/designer-backend-skeleton. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shirtnetwork/designer-backend-skeleton
More information about shirtnetwork/designer-backend-skeleton
Files in shirtnetwork/designer-backend-skeleton
Package designer-backend-skeleton
Short Description Project skeleton for shirtnetwork designer backend solution
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package designer-backend-skeleton
Shirtnetwork Designer Backend
This backend will handle configuration files, font management and uploading files for the shirtnetwork designer. This backend is used for all implementations. Feel free to adapt this skeleton to your own needs.
:exclamation: We recommend using the nodejs based version whenever possible
Installation
Use git to clone the repository
Then install the dependencies using composer inside the created folder
Configuration
The repository comes with a config.inc.sample.php file, copy this file to config.inc.php and adjust it to your needs. If you do not copy the file before first request it will be created automatically. Files are stored in the var/ subfolders by default.
Point your webserver to serve the root of the application, it is pre configured to work with apache webserver. We recommend using a subdomain or a separate domain for the app e.g.: https://config.example.org
Usage
Depending on your consuming system you will need to configure upload and config urls. Use as following:
Upload Endpoint
https://config.example.org/files
Config Endpoint
Fire up the settings interface to define fonts:
https://config.example.org/settings/fonts
Security
:exclamation: Be sure to add at least one user in the auth section of the config file, otherwise authentication is skipped and everybody will be able to modify your settings.
Also be sure to set allowed-origins in config.inc.php so only specific endpoints can upload files and configurations.
NGINX
You can use NGINX as a webserver, as the designer backend is a slim application you will have to configure NGINX as following
:exclamation:
Since nginx will not route /config routes using this method you can rename config.inc.php to cfg.inc.php
as a workaround. See the Slim v4 Documentation
for further information.
Contributions to improving the nginx config are very welcome.
Cron
To cleanup old uploaded files including their metadata the server ships with a symfony console command. Execute as following
This will delete all files older than 30 days, if the file was manifested it is valid 3 years instead.
Updating
Similar to installing, if you did not change the skeleton do the following:
Omit git pull if you did any changes to the skeleton.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
