Feat add description in english

README.md

@@ -59,7 +59,8 @@ MAIL_TEST_BOUNCED=[Email para teste : erro]
 MAIL_TEST_COMPLAINED=[Email para teste : marcado como spam]
 # ex: [email protected]
 
-POSTGRES_USER=[Nome de usuário do baco de dados]
+POSTGRES_USER=[Nome de usuário do banco de dados]
+
 # ex: admin
 
 POSTGRES_PASSWORD=[Senha do banco de dados]
@@ -87,7 +88,8 @@ $ git submodule update --init --recursive
 
 ### Dependências
 
-Depois de clonar e semple que atualizar o repositório, execute o comando abaixo para manter as dependências atualizadas.
+Depois de clonar e sempre que atualizar o repositório, execute o comando abaixo para manter as dependências atualizadas.
+
 ```bash
 $ yarn
 ```
@@ -138,3 +140,137 @@ $ yarn test
 LoryBlu tem [licença MIT](LICENSE).
 
 </details>
+
+
+Description in <b>en</b>
+
+### Requirements
+1. [Node.js 18.x LTS](https://nodejs.org/en) Installed.
+1. [PostgreSQL](https://www.postgresql.org/) or [docker + docker-compose](https://docs.docker.com/compose/) installed.
+1. [Resend](https://resend.com/home) Email service used in the application.
+
+> ⚠ If you have `docker` and `docker-compose` intalled, you do not need to install `PostgreSQL` (database), there is a configured file to use PostgreSQL in docker, `docker-compose.dev.yml`
+
+## Clone the repository
+
+Testes unitários
+```bash
+
+# git clone <repo-url> <dist>
+git clone https://github.com/loryblu/loryblu-api.git loryblu-api
+```
+
+This comamnd will clone the repository to the specified destination. You can omit the destination.
+
+## Set up the enviroment
+1. Duplicate the `.env.example` file from the main project;
+1. Rename it to `.env`;
+
+Update the new `.env` with the following instructions:
+```md
+# Replace the examples inside square brackets "[Database username]" with the final value "root"
+
+PORT=[Port that the server exposes]
+# e.g.: 8080
+
+NODE_ENV=[Current environment]
+# e.g.: development
+
+SALT_DATA_HASH=[Secret key to merge with the sensitive data hash]
+# e.g.: secret.salt.data
+
+SALT_DATA_PASS=[Secret key to randomize the password]
+# e.g.: 8
+
+MAIL_API_KEY=[Resend service key]
+# e.g.: re_123456789
+
+MAIL_FROM=[Application contact email]
+# e.g.: [email protected]
+
+MAIL_TEST_DELIVERED=[Test email : success]
+# e.g.: [email protected]
+
+MAIL_TEST_BOUNCED=[Test email : error]
+# e.g.: [email protected]
+
+MAIL_TEST_COMPLAINED=[Test email: marked as spam]
+# e.g.: [email protected]
+
+POSTGRES_USER=[Database username]
+# e.g.: admin
+
+POSTGRES_PASSWORD=[Database password]
+# e.g.: strongPass
+
+POSTGRES_DB=[Database name]
+# e.g.: loryblu-clone-api
+
+POSTGRES_HOST=[Database host]
+# e.g.: localhost
+
+POSTGRES_PORT=[Database port]
+# e.g.: 5432
+
+DATABASE_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}?schema=public"
+# ! This value does not need to be changed, use it as is.
+```
+
+## Installation
+### Submodules
+After cloning this repository, and if one of the submodules is added or updated, run the following command to update and initialize all submodules.
+```bash
+$ git submodule update --init --recursive
+```
+
+### Dependencies
+
+After cloning and whenever you update the repository, run the following command to keep the dependencies up to date.
+```bash
+$ yarn
+```
+
+## Running the application
+
+<details>
+<summary><b>Are you using Docker?</b></summary>
+
+Use the command below to download the PostgreSQL:14-alpine image and configure the credentials.
+```bash
+docker-compose -f docker-compose.dev.yml up -d
+```
+
+If you prefer, there is a script configured to perform this command and all other development commands. It also starts the application:
+```bash
+yarn docker:dev
+```
+
+</details>
+
+---
+
+This command performs everything necessary to set up the development database.
+```bash
+$ yarn dev
+```
+
+This command only starts the application in development mode.
+```bash
+$ yarn start:dev
+```
+
+This command starts the application in production mode.
+```bash
+$ yarn run start:prod
+```
+
+## Tests
+
+Unit tests
+```bash
+$ yarn test
+```
+
+## License
+
+LoryBlu has [licença MIT](LICENSE).