Skip to content

Latest commit

 

History

History
72 lines (64 loc) · 3.71 KB

USAGE_CHECKLIST.md

File metadata and controls

72 lines (64 loc) · 3.71 KB

What is this?

This document contains basic checklist what you need to do if you're going to use this template as in base of your own application.

Table of Contents

Checklist ᐞ

Below you have basic checklist that you need to go through after you have started to use this template.

  • Check that LICENSE matches to your needs and change it if needed.
  • Check that README.md contains only things related to your application.
  • Update composer.json to match with your application. Below you see the parts that you should check/update;
    • Common properties; name, description, keywords, homapage, version, license, authors, support.issues and extra.projectTitle
  • Application configuration / setup
    • .env Change APP_SECRET value with new one, you can use eg. this tool for that. Also remember to change that APP_SECRET value in .env.test and in .env.gh-actions files.
    • application.json Change file contents to match your application configuration - specially you need to generate new JWT_PASSPHRASE value. Also remember to do those changes to application_test.json files.
    • site.webmanifest - check that file contents - information - and made necessary changes.
    • robots.txt - check that file contents - information - and made necessary changes.
    • favicon.ico - change your application favicon to match your brand.
    • compose.yaml Change container_name to match your application.
    • mysql_custom.cnf Check that MySQL has custom configuration that your application needs. Also check that Dockerfile is matching your production setup.
    • nginx.conf Check that Nginx has proper configuration for your application needs. Also check that Dockerfile is matching your production setup.
    • php.ini Check that PHP has proper production configuration. Also check php-dev.ini for development environment setup.
  • 3rd party services that you might not need or you need to change those to work with your application - if you don't need to use those services just delete those files and all is done.
  • Github Actions - This application is using GitHub Actions to run multiple jobs to check application code.
  • Last step when all above is done - just delete this file.

Back to resources index - Back to main README.md