You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This folder is a storage for project data files and service caches.
59
59
It contains these folders:
60
60
61
-
*`cache`: cache for e.g. Twig files
62
-
*`doctrine`: database migrations and fixtures
63
-
*`oauth`: encryption, private and public keys needed for authentication
64
-
*`data/lock` - lock files generated by [`dotkernel/dot-cli`](https://docs.dotkernel.org/dot-cli/v3/lock-files/)
61
+
*`cache` - Cache for e.g. Twig files
62
+
*`doctrine` - Database migrations and fixtures
63
+
*`oauth` - Encryption, private and public keys needed for authentication
64
+
*`lock` - Contains lock files generated by [`dotkernel/dot-cli`](https://docs.dotkernel.org/dot-cli/v3/lock-files/)
65
65
66
66
> AVOID storing sensitive data on the repository!
67
67
@@ -74,20 +74,20 @@ When you access the application from the browser, (if not already created) a new
74
74
75
75
This folder contains all publicly available assets and serves as the entry point of the application:
76
76
77
-
*`uploads`: a folder that normally contains files uploaded via the application
78
-
*`.htaccess`: server configuration file used by Apache web server; it enables the URL rewrite functionality
79
-
*`index.php`: the application's main entry point
80
-
*`robots.txt.dist`: a sample robots.txt file that allows/denies bot access to certain areas of your application; activate it by duplicating the file as `robots.txt` and comment out the lines that don't match your environment
77
+
*`uploads` - Normally contains files uploaded via the application
78
+
*`.htaccess` - Server configuration file used by Apache web server; it enables the URL rewrite functionality
79
+
*`index.php` - The application's main entry point
80
+
*`robots.txt.dist` - A sample robots.txt file that allows/denies bot access to certain areas of your application; activate it by duplicating the file as `robots.txt` and comment out the lines that don't match your environment
81
81
82
82
## `src` folder
83
83
84
84
This folder contains a separate folder for each Module.
85
85
86
86
These are the modules included by default:
87
87
88
-
*`Admin` - contains functionality for managing users with `admin` role; note these are users save in the `admin` database table
89
-
*`App` - contains core functionality, from authentication, to rendering, to error reporting
90
-
*`User` - contains functionality for managing regular users
88
+
*`Admin` - Contains functionality for managing users with `admin` role; note these are users save in the `admin` database table
89
+
*`App` - Contains core functionality, from authentication, to rendering, to error reporting
90
+
*`User` - Contains functionality for managing regular users
91
91
92
92
### Module contents
93
93
@@ -96,7 +96,6 @@ Each Module folder, in turn, should contain the following folders, unless they a
96
96
*`src/Handler` - Action classes (similar to Controllers but can only perform one action)
97
97
*`src/Entity` - Used by database entities
98
98
*`src/Service` - Service classes
99
-
*`src/Collection` - Database entities collections
100
99
*`src/Repository` - Entity repository folder
101
100
102
101
The above example is just some of the folders a project may include, but they should give you an idea about the recommended structure.
@@ -112,4 +111,5 @@ The `src` folder in each Module folder normally also contains these files:
112
111
113
112
This folder contains the template files, used for example to help render e-mail templates.
114
113
115
-
> Dotkernel API uses twig as Templating Engine. All template files have the extension `.html.twig`
114
+
> `twig` is used as Templating Engine.
115
+
> All template files have the extension `.html.twig`
0 commit comments