From 7e4a0502722571791d8b0dec208c3a392f81b456 Mon Sep 17 00:00:00 2001
From: matheuspdf <matheuslopes.pdf@gmail.com>
Date: Thu, 17 Oct 2024 16:04:04 -0300
Subject: [PATCH] Melhora o README

---
 README.md | 118 ++++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 88 insertions(+), 30 deletions(-)

diff --git a/README.md b/README.md
index ce8ba89..6ea1b5d 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,96 @@
+
 # Eventex
 
-Sistema de Eventos encomendado pela Morena
+Sistema de Eventos encomendado pela Morena.
+
+## Índice
+
+- [Como desenvolver](#como-desenvolver)
+- [Como fazer o deploy](#como-fazer-o-deploy)
+
+## Como desenvolver
+
+Siga os passos abaixo para configurar o ambiente de desenvolvimento da aplicação:
+
+1. **Clone o repositório**:
+   ```bash
+   git clone git@github.com:matheuspdf/eventex.git
+   cd eventex
+   ```
+
+2. **Crie um ambiente virtual** usando o `pipenv` e instale as dependências:
+   ```bash
+   pipenv install --ignore-pipfile
+   ```
+
+3. **Ative o ambiente virtual**:
+   ```bash
+   pipenv shell
+   ```
+
+4. **Configure as variáveis de ambiente** copiando o arquivo de exemplo:
+   ```bash
+   cp contrib/env-sample .env
+   ```
 
+5. **Execute os testes** para garantir que tudo está funcionando corretamente:
+   ```bash
+   python manage.py test
+   ```
 
-## Como desenvolver?
-1. Clone o repositório.
-2. Crie e ative um ambiente virtual com Python 3.5+ usando o pipenv.
-3. Instale as dependências.
-4. Configure a instância com o .env
-5. Execute os testes.
+6. **Rode as migrações** para configurar o banco de dados:
+   ```bash
+   python manage.py migrate
+   ```
 
-```console
-git clone git@github.com:matheuspdf/eventex.git wttd
-cd wttd
-python -m venv .wttd
-source .wttd/bin.activate
-pip install -r requirements.txt
-cp contrib/env-sample .env
-python manage.py test
-```
+7. **Inicie o servidor**:
+   ```bash
+   python manage.py runserver
+   ```
+8. Para criar um super usuário e utilizar o admin do Django
+   ```bash
+   python manage.py createsuperuser
+   ```
+
+Agora você pode acessar o sistema em `http://localhost:8000`.
+
+---
 
 ## Como fazer o deploy
 
-1. Crie uma instância no Fly.io.
-2. Envie as configurações para o heroku. 
-3. Defina uma SECRET_KEY segura para instância
-4. Defina DEBUG=False
-5. Configure o serviço de email.
-6. Envie o código para o heroku.
-```console
-heroku create minhainstancia
-heroku config:push
-heroku config: set SECRET_KEY=`python contrib/secret_gen.py`
-heroku config:set DEBUG=False
-# configuro o email
-git push heroku master --force
-```
\ No newline at end of file
+Siga estes passos para realizar o deploy da aplicação no **Fly.io**:
+
+1. **Instale o Fly.io CLI**:
+   ```bash
+   curl -L https://fly.io/install.sh | sh
+   ```
+
+2. **Crie uma conta no Fly.io** (se você ainda não tiver):
+   ```bash
+   fly auth signup
+   ```
+
+3. **Faça login** na sua conta Fly.io:
+   ```bash
+   fly auth login
+   ```
+
+4. **Inicialize e configure a aplicação** para Fly.io:
+   ```bash
+   fly launch
+   ```
+   - Escolha um nome para a aplicação quando solicitado.
+   - Selecione a região desejada.
+   - Não crie o banco de dados agora (a menos que precise).
+
+5. **Defina as variáveis de ambiente** na instância Fly.io. Por exemplo:
+   ```bash
+   flyctl secrets set SECRET_KEY=$(python contrib/secret_gen.py) DEBUG=False
+   ```
+
+6. **Faça o deploy da aplicação**:
+   ```bash
+   flyctl deploy
+   ```
+
+---
\ No newline at end of file