doc: create readme

Gustavo-Murdiga88 · Mar 27, 2024 · eb9d9fc · eb9d9fc
1 parent 0511b03
commit eb9d9fc
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,5 @@
+
+DATABASE_URL="postgresql://docker:docker@localhost:5432/dashskins?schema=dashskins"
+JWT_SECRET="@dashskins:token"
+PORT=3000
+STORAGE="temp"
diff --git a/README.md b/README.md
@@ -31,6 +31,8 @@
   ```
   <br>
 
+  Crie um arquivo **.env** no repositório principal, e copie todos os dados do arquivo **.env.example** e cole no seu novo arquivo **.env**, após isso a url de conexão do banco de dados e a assinatura do jwt poderão ser lidas pelo servidor.
+
   Logo após iremos baixar as dependências, no diretório principal execute
 
    ```shell
@@ -57,4 +59,8 @@
    ```shell
     pnpm run dev
    ```
-  após este processo, você receberá uma confirmação no seu terminal com todas as rotas hoje disponível no sistema.
+  após este processo, você receberá uma confirmação no seu terminal com todas as rotas hoje disponível no sistema.
+
+  ## Swagger
+
+  Para uma visão mais clara das rotas abra seu navegador na rota "http://localhost:3000/api"