# Boilerplate Structure

| Folder/File    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| \_\_test\_\_   | Accommodate all unit test needs using jest, which includes snapshot tests, logic testing etc.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| .next          | Place for rendering the next.js file in development or production mode                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| .vscode        | Default script running for debugging using Visual Studio Code (VS Code)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| public         | <p>Serve static files, like images, robot SEO, fonts, manifest json, etc. under a folder called <code>public</code> in the root directory. Files inside <code>public</code> can then be referenced by your code starting from the base URL (<code>/</code>).</p><p></p><p><strong>fonts</strong> (<em>Collection font type</em>)</p><p><strong>img</strong> </p><ul><li>bg (<em>Images for background element</em>)</li><li>errors (<em>Images for errors page</em>)</li><li>icons (<em>Images for icon</em>)</li><li>logo (<em>Images for logo</em>)</li><li>media (<em>Images for common</em>)</li></ul><p><strong>locales</strong> <em>(Language variants data)</em></p><p><strong>manifest-example.json</strong> (<em>manifest data</em>)</p><p><strong>robots-example.txt</strong> (<em>robots web for support Google robots</em>)</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| src            | <p>Special folder to hold all files related to development process. </p><p></p><p><strong>components</strong> (<em>All components app</em>)</p><ul><li>common (<em>Components local custom</em>)</li><li>page (<em>Partial components for high order component from page</em>)</li></ul><p><strong>config</strong> (<em>Collect APIs, constant files etc</em>)</p><ul><li>apis (<em>Collection API list</em>)</li><li>constants (<em>Collection constants variables</em>)</li></ul><p><strong>hooks</strong> (<em>Coming soon</em>)</p><p></p><p><strong>html</strong> <em>(All HTML code)</em></p><p></p><p><strong>layouts</strong> (<em>Layout types app</em>)</p><ul><li>dashboard (<em>Dashboard layout type</em>)</li><li>landing (<em>Landing layout type</em>)</li><li>mobile (<em>Mobile view layout type</em>)</li></ul><p><strong>lib</strong> (<em>3rd party configs</em>)</p><ul><li>firebase (<em>Firebase configs</em>)</li><li>jest (<em>Unit testing configs</em>)</li><li>redux (<em>State management configs</em>)</li></ul><p><strong>pages</strong> (<em>Routing system next.js. Each page is associated with a route based on its file name.</em>)</p><ul><li>api (<em>Mock dummy API</em>)</li><li>\_app.js (<em>Next.js uses the App component to initialize pages</em>)</li><li>\_document.js (<em>A custom <code>Document</code> is commonly used to augment your application's <code>\<html></code> and <code>\<body></code> tags.</em>)</li><li>404.js (<em>Error page for not found page</em>)</li><li>500.js (<em>Error page for internal server error</em>)</li><li>index.js (<em>Index page Next.js app</em>)</li></ul><p><strong>store</strong> (<em>Handle state management system</em>)</p><p></p><p><strong>styles</strong> (<em>Custom styles configs</em>)</p><ul><li>global (<em>global stylesheet configs</em>)</li><li>override (<em>custom & override CSS framework</em>)</li></ul><p><strong>utils</strong> (<em>Handle all utility code like as helpers code</em>)</p> |
| .env-example   | Default sample for env configs                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| .gitignore     | Plain text file where each line contains a pattern for files/directories to ignore.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| jest.config.js | Jest's configuration files project                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| jsconfig.json  | File specifies the root files and the options for the features provided by the JavaScript language service. There are alias path configuration.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| next.config.js | NextJS's configuration files project                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| package.json   | JSON file that exists at the root of a Javascript/Node project.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| server.js      | Server configuration project                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fe-qasir.gitbook.io/qiblat-documentation/code-structure.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.