Projecto To Do List

Este documento fornece instruções detalhadas sobre como configurar e executar o projeto To do List.

Pré-requisitos

Antes de começar, certifique-se de ter os seguintes programas instalados em sua máquina:

• Git
• Composer
• PHP (versão 8.0 ou superior)
• Node.js
• Um servidor de banco de dados como MySQL ou PostgreSQL

Passos para rodar a aplicação

1. Clonar o projeto do GitHub

1. Abra o terminal.
2. Navegue até o diretório onde você deseja clonar o projeto.
3. Execute o comando abaixo para clonar o repositório:

git clone https://github.com/Dumilson/back-end-task.git

2. Instalar as dependências

Navegue até o diretório do projeto e instale as dependências do PHP usando o Composer:

cd back-end-task
composer install

3. Configurar as chaves no .env

Renomeie o arquivo .env.example para .env:

cp .env.example .env

Gere uma chave de aplicativo Laravel:

php artisan key:generate

4. Configurar o banco de dados

Abra o arquivo .env e configure as seguintes variáveis de ambiente de acordo com seu servidor de banco de dados:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=nome_do_banco_de_dados
DB_USERNAME=seu_usuário
DB_PASSWORD=sua_senha

5. Migrar o banco de dados e rodar os seeders

Execute as migrações para criar as tabelas no banco de dados:

php artisan migrate

Em seguida, execute o seeder para adicionar os usuários ao banco de dados:

php artisan db:seed --class=UserSeeder

6. Informações pré-definidas inseridas pelo seed

O seeder UserSeeder irá adicionar os seguintes usuários ao banco de dados:

• Admin User
  • Email: [email protected]
  • Senha: 123456

Certifique-se de que o servidor do banco de dados está em execução e as credenciais configuradas no arquivo .env são corretas.

7. Iniciar o servidor de desenvolvimento

Finalmente, inicie o servidor de desenvolvimento do Laravel:

php artisan serve

A aplicação estará disponível em http://localhost:8000.

Processo de Deploy

O projeto está configurado para deploy automático usando GitHub Actions. O fluxo de trabalho é o seguinte:

1. Todas as atualizações devem ser feitas na branch develop.
2. Quando as alterações estiverem prontas para ir para produção, abra um Pull Request da branch develop para a branch master.
3. Quando o Pull Request for aprovado e mesclado na branch master, o GitHub Actions iniciará o processo de deploy automaticamente.

Documentação de API em Produção

https://todo.domingosbraganha.tech/