2019-10-09 12:32:58 +02:00
|
|
|
# Files structure
|
|
|
|
|
|
|
|
|
|
By default, your project's structure will look like this:
|
|
|
|
|
|
2019-12-09 00:08:51 -05:00
|
|
|
- `/.cache`: contains files used to build your admin panel.
|
|
|
|
|
- [`/admin`](../admin-panel/customization.md): contains your admin customization files.
|
2020-03-22 13:28:03 -04:00
|
|
|
- `/api`: contains the business logic of your project split into sub-folders per API.
|
2019-10-09 12:32:58 +02:00
|
|
|
- `**`
|
2020-02-08 16:13:14 +01:00
|
|
|
- `/config`: contains the API's configurations ([`routes`](./routing.md), [`policies`](./policies.md), etc.).
|
2019-10-09 12:32:58 +02:00
|
|
|
- [`/controllers`](./controllers.md): contains the API's custom controllers.
|
|
|
|
|
- [`/models`](./models.md): contains the API's models.
|
|
|
|
|
- [`/services`](./services.md): contains the API's custom services.
|
2019-12-09 00:08:51 -05:00
|
|
|
- `/build`: contains your admin panel UI build.
|
2019-10-09 12:32:58 +02:00
|
|
|
- [`/config`](./configurations.md)
|
|
|
|
|
- [`/environments`](./configurations.md#environments): contains the project's configurations per environment.
|
|
|
|
|
- `/**`
|
|
|
|
|
- `/development`
|
|
|
|
|
- [`custom.json`](./configurations.md#custom): contains the custom configurations for this environment.
|
|
|
|
|
- [`database.json`](./configurations.md#database): contains the database connections for this environment.
|
|
|
|
|
- [`request.json`](./configurations.md#request): contains the request settings for this environment.
|
|
|
|
|
- [`response.json`](./configurations.md#response): contains the response settings for this environment.
|
2020-03-22 13:28:03 -04:00
|
|
|
- [`security.json`](./configurations.md#security): contains the security settings for this environment.
|
2019-10-09 12:32:58 +02:00
|
|
|
- [`server.json`](./configurations.md#server): contains the server settings for this environment.
|
|
|
|
|
- `/production`
|
|
|
|
|
- `/staging`
|
|
|
|
|
- [`/functions`](./configurations.md#functions): contains lifecycle or generic functions of the project.
|
2020-03-22 13:28:03 -04:00
|
|
|
- [`/responses`](./configurations.md#responses): contains custom responses.
|
|
|
|
|
- [`404.js`](./configurations.md#404): contains a template for constructing your custom 404 message.
|
2019-10-09 12:32:58 +02:00
|
|
|
- [`bootstrap.js`](./configurations.md#bootstrap): contains the code executed at the application start.
|
|
|
|
|
- [`cron.js`](./configurations.md#cron-tasks): contains the cron tasks.
|
|
|
|
|
- [`application.json`](./configurations.md#application): contains the general configurations of the project.
|
|
|
|
|
- [`custom.json`](./configurations.md#custom): contains the custom configurations of the project.
|
|
|
|
|
- [`hook.json`](./configurations.md#hook): contains the hook settings of the project.
|
2020-03-22 13:28:03 -04:00
|
|
|
- [`language.json`](./configurations.md#language): contains the language settings of the project.
|
2019-10-09 12:32:58 +02:00
|
|
|
- [`middleware.json`](./configurations.md#middleware): contains the middleware settings of the project.
|
2019-12-09 00:08:51 -05:00
|
|
|
- [`/extensions`](./customization.md): contains the files to extend installed plugins.
|
2019-10-09 12:32:58 +02:00
|
|
|
- [`/hooks`](./hooks.md): contains the custom hooks of the project.
|
|
|
|
|
- [`/middlewares`](./middlewares.md): contains the custom middlewares of the project.
|
|
|
|
|
- [`/plugins`](./plugins.md): contains your local plugins.
|
2020-03-22 13:28:03 -04:00
|
|
|
- [`/public`](./public-assets.md): contains the files accessible to the outside world.
|
2020-02-08 16:13:14 +01:00
|
|
|
- `/node_modules`: contains the npm packages used by the project.
|
