From 938bcd6dc49821670890538a4039a8ff3cb5e782 Mon Sep 17 00:00:00 2001 From: Deusimar Date: Mon, 13 Sep 2021 21:43:49 -0300 Subject: [PATCH] chore(docs): addded more descriptions on readme --- .env.example | 3 +++ README.md | 19 ++++++++++++++++++- 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 .env.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..a18f960 --- /dev/null +++ b/.env.example @@ -0,0 +1,3 @@ +REDIS_HOST=localhost +REDIS_PASS= +REDIS_PORT=6379 \ No newline at end of file diff --git a/README.md b/README.md index 08ea856..b3c4897 100644 --- a/README.md +++ b/README.md @@ -15,5 +15,22 @@ ## :gear: Arquitetura inicial - + +
+ +## Executando o projeto + +* Versão do [Node.js](https://nodejs.org/): +```console +v14.17.1 +``` + +* É necessário se conectar a uma instância do [Redis](https://redis.io/). Recomendo fortemente o uso do [Docker](https://www.docker.com/) para criar +uma instância na sua própria máquina. Com o docker instalado, basta executar o seguinte comando que estará criada a sua instância do banco de dados do Redis: + +```console +deusimar@deusimar:~$ docker run --name redis -p 6379:6379 redis +``` + +continua...