Newsletter PHP

O Newsletter é um projeto pessoal de estudo que visa aplicar todos os meus conhecimentos no desenvolvimento de software, abrangendo aspectos de desenvolvimento, arquitetura, banco de dados e computação em nuvem. Como o nome sugere, trata-se de uma aplicação para gestão de listas de newsletters, permitindo a criação de várias listas com diferentes tópicos e a inscrição dos usuários em suas listas preferidas.

Tecnologias / Conceitos utilizados:

PHP 8.3
Laravel 11
Docker
Docker Compose
API Restful
Documentação com Open API
Testes automatizados
Relatório de cobertura de testes
Qualidade de código (PHP CS, PHP Stan)
MySQL
Redis

Modelagem do banco de dados

erDiagram
    user ||--|{ topic : has
    user ||--|{ newsletter : has
    message ||--|{ newsletter : has
    newsletter ||--|{ subscription : has
    topic ||--|{ topic_newsletter : has
    newsletter ||--|{ topic_newsletter : has

    user {
        int id PK
        string name
        string email
        string password
        datetime created_at
        datetime updated_at
        datetime deleted_at
    }

    newsletter {
        int id PK
        int user_id FK
        string name
        string description
        datetime created_at
        datetime updated_at
        datetime deleted_at
    }
    
    message {
        int id PK
        int newsletter_id FK
        string subject
        string cotent
        datetime created_at
        datetime updated_at
        datetime deleted_at
    }

    subscription {
        int id PK
        int newsletter_id FK
        string email
        datetime created_at
        datetime updated_at
        datetime deleted_at
    }

    topic_newsletter {
        int topic_id
        int newsletter_id
    }

    topic {
        int id PK
        int user_id FK
        string name
        string description
        datetime created_at
        datetime updated_at
        datetime deleted_at
    }

Desenvolvimento local

A seguir estão as instruções para executar o aplicativo em seu ambiente local utilizando Docker e Docker Compose.

Configuração do Ambiente

Antes de começar, é necessário criar um arquivo .env com base no .env.example. Você pode fazer isso executando o seguinte comando no terminal:

cp .env.example .env

Construção da Imagem Docker do PHP

Primeiro, navegue até o diretório docker

cd docker

Em seguida, construa a imagem Docker para o aplicativo executando o seguinte comando

docker build -t newsletter .

Execute seu docker-compose para subir toda a stack da aplicação

docker-compose up -d

Chave para o Ambiente Local:

Em seguida, execute o comando para gerar uma chave do laravel para seu ambiente local

docker-compose exec app php artisan key:generate

Criação das Tabelas do Banco de Dados

Utilize o seguinte comando para gerar as tabelas do banco de dados:

docker-compose exec app php artisan migrate

Testes HTTP

Para verificar se todos os testes estão passando, execute o seguindo comando

docker-compose exec app php artisan test

dcorrea777 / newsletter