Skip to content

Commit 6a80b4b

Browse files
committed
Update user guide
1 parent 7befc6a commit 6a80b4b

1 file changed

Lines changed: 20 additions & 14 deletions

File tree

guide/index.rst

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,14 @@ Bootstrap
7878
Inside the **boot** directory are located files that are part of the application
7979
startup.
8080

81-
The **app.php** file returns the instance of the **App** class, which is called
82-
to run the application in HTTP or CLI.
81+
App
82+
###
83+
84+
The **app.php** file is responsible for loading the files needed for the app to work.
85+
Such as the Composer autoloader or the initialization files.
86+
87+
It returns an instance of the ``App`` class, which is called to run the application
88+
in HTTP or CLI.
8389

8490
Init
8591
####
@@ -155,7 +161,7 @@ Upload files are stored in the **uploads** directory.
155161
The global class App
156162
--------------------
157163

158-
The global class **App**, whose file is located in the root directory, extends
164+
The global class ``App``, whose file is located in the root directory, extends
159165
the ``Framework\MVC\App`` class.
160166

161167
Through it, it is possible to customize features and
@@ -237,7 +243,7 @@ Deployment
237243

238244
We will see how to deploy to a `Shared Hosting`_ and a `Private Server`_:
239245

240-
In the following examples, configurations will be made for the domain ``domain.tld``.
246+
In the following examples, configurations will be made for the domain **domain.tld**.
241247
Replace it with the domain of your application.
242248

243249
Shared Hosting
@@ -246,18 +252,18 @@ Shared Hosting
246252
In shared hosting, it is common that you can upload the project files only by FTP.
247253

248254
Also, typically the document root is a publicly accessible directory called
249-
``www``, ``web`` or ``public_html``.
255+
**www**, **web** or **public_html**.
250256

251257
And the server is Apache, which allows configurations through files called
252-
``.htaccess``.
258+
**.htaccess**.
253259

254260
In the following example the settings can be made locally and then sent to the
255261
hosting server.
256262

257263
Environment Variables
258264
"""""""""""""""""""""
259265

260-
Environment variables are defined in the ``.env.php`` file.
266+
Environment variables are defined in the **.env.php** file.
261267

262268
Edit them according to the examples below:
263269

@@ -291,8 +297,8 @@ Install dependencies with Composer:
291297
.htaccess files
292298
"""""""""""""""
293299

294-
In the document root and in the ``public`` directory of the application has
295-
``.htaccess`` files that can be configured as needed.
300+
In the document root and in the **public** directory of the application has
301+
**.htaccess** files that can be configured as needed.
296302

297303
For example, redirecting insecure requests to **HTTPS** or redirecting to the
298304
**www** subdomain.
@@ -372,7 +378,7 @@ Set the owner of the storage directory:
372378
373379
sudo chown -R www-data:www-data storage
374380
375-
Edit the Environment and the URL Origin of your project in the ``.env.php``
381+
Edit the Environment and the URL Origin of your project in the **.env.php**
376382
file:
377383

378384
.. code-block:: php
@@ -386,7 +392,7 @@ Install the necessary PHP packages through Composer:
386392
387393
composer install --no-dev --ignore-platform-req=ext-xdebug
388394
389-
* We use ``install`` instead of ``update`` to respect the ``composer.lock`` file if it exists in your repository.
395+
* We use ``install`` instead of ``update`` to respect the **composer.lock** file if it exists in your repository.
390396

391397
* We use ``--ignore-platform-req=ext-xdebug`` because we don't need the xdebug extension in production.
392398

@@ -413,7 +419,7 @@ Enable modules:
413419
414420
sudo a2enmod rewrite
415421
416-
Create the file ``/etc/apache2/sites-available/domain.tld.conf``:
422+
Create the file **/etc/apache2/sites-available/domain.tld.conf**:
417423

418424
.. code-block:: apacheconf
419425
@@ -447,7 +453,7 @@ It should open the home page of your project.
447453
Nginx (recommended)
448454
^^^^^^^^^^^^^^^^^^^
449455

450-
Edit the ``php.ini`` file:
456+
Edit the **php.ini** file:
451457

452458
.. code-block::
453459
@@ -465,7 +471,7 @@ Install required packages:
465471
466472
sudo apt install nginx
467473
468-
Create the file ``/etc/nginx/sites-available/domain.tld.conf``:
474+
Create the file **/etc/nginx/sites-available/domain.tld.conf**:
469475

470476
.. code-block:: nginx
471477

0 commit comments

Comments
 (0)