From 912986f2e2c93f5d637f77c5cd5ccddd6e24d51a Mon Sep 17 00:00:00 2001 From: caduwinter <104656553+caduwinter@users.noreply.github.com> Date: Sat, 2 Dec 2023 21:23:38 -0300 Subject: [PATCH] Create README.md --- README.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 93 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bb84a46 --- /dev/null +++ b/README.md @@ -0,0 +1,93 @@ +# Português +# Guia de Execução do Aplicativo + +## Requisitos Necessários + +Certifique-se de ter os seguintes componentes instalados em seu sistema: + +- [Docker](https://www.docker.com/) +- [Node.js](https://nodejs.org/) + +## Procedimentos de Execução + +1. Clone o repositório do aplicativo para o seu sistema. + + ```bash + git clone https://github.com/seu-usuario/nome-do-repositorio.git + ``` + +3. Navegue até o diretório do aplicativo. + + ```bash + cd nome-do-repositorio + ``` + +5. Instale as dependências do projeto utilizando o npm. + + ```bash + npm i + ``` + +7. Configure o arquivo `.env` com `MONGO_URL` sendo a URL de conexão para o seu MongoDB. + +8. Inicie o bot com o seguinte comando: + + ```bash + npm run dev + ``` + +10. Inicie o servidor com o seguinte comando: + + ```bash + npm run server + ``` + + +Após seguir esses passos, o aplicativo estará em execução. Certifique-se de que todas as dependências foram instaladas corretamente e que nenhum erro ocorreu durante o processo de inicialização. + +# English +# Application Execution Guide + +## Prerequisites + +Make sure you have the following components installed on your system: + +- [Docker](https://www.docker.com/) +- [Node.js](https://nodejs.org/) + +## Execution Steps + +1. Clone the application repository to your system. + + ```bash + git clone https://github.com/your-username/repository-name.git + ``` + +2. Navigate to the application directory. + + ```bash + cd repository-name + ``` + +3. Install project dependencies using npm. + + ```bash + npm i + ``` + +4. Configure the `.env` file with `MONGO_URL` set to your MongoDB connection URL. + +5. Start the bot with the following command: + + ```bash + npm run dev + ``` + +6. Start the server with the following command: + + ```bash + npm run server + ``` + +After following these steps, the application will be up and running. Ensure that all dependencies were installed correctly and no errors occurred during the startup process. +