mateusbmp/intrachat

This package is abandoned and no longer maintained. No replacement package was suggested.

Chat de texto em PHP

dev-master 2021-02-09 12:29 UTC

Requires

• php: ^7.2
• mateusbmp/crud: ^1.0
• vlucas/phpdotenv: ^3.3

Requires (Dev)

• phpunit/phpunit: ^8

GLP-3.0-or-later

• Mateus Pereira
• Jadde Leite
• Erycles Silva

• chat

README

Apresentacao

O IntraChat e um chat de texto em PHP, usando banco de dados para documentar as conversas e validar o usuario, enquanto estabelece comunicacao via aplicacao entre os usuarios. Sua estrutura visa a aplicacao em diferentes projetos e, desta forma, possui uma estrutura flexivel e de mais simples configuracao possivel.

Sua documentacao foi inteiramente escrita usando Markdown.

Para mais detalhes sobre a documentacao do projeto ou como colaborar como mesmo, acesse o diretorio documentacao na raiz do projeto.

Procedimento basico

A aplicacao foi desenvolvida para funcionar tanto localmente quanto em um servidor de aplicacao e, por isso, exige ser configurado e instalado antes de ser usado. Para isso, siga o seguinte protocolo:

• Criar aquivo .env de acordo com arquivo de referencia .env.example
• Configurar arquivo .env de acordo com as necessidades da aplicacao
• Executar os comandos composer update e composer dump-autoload -o
• Importar a classe Administrador e executar a funcao instalar

O arquivo .env armazena informacoes essenciais a aplicacao, como parametros de conexao ao banco de dados e tipo de banco usado. Desta forma, esse arquivo nao deve ser incorporado ao corpo do codigo que sera compartilhado, a nao ser que se possua confianca ao transmitir esses dados.

Apos criar o arquivo .env, edite pelo menos as variaveis de banco de dados, ou seja, as que comecam com BD_.

Por ultimo, execute a funcao instalar presente na classe Administrador. Essa criara os arquivos basicos da aplicacao, como o chat e o banco de dados. Para mais informacoes em como executa-la, leia a documentacao da classe.

Quando desejar ativar o servidor, execute a funcao ativar presente na classe Administrador. Quando desejar desativar o servidor, execute a funcao desativar tambem presente na mesma classe.

Agora, para que o cliente use a aplicacao, use a classe Chat ou a propria interface fornecida. As interfaces fornecidas se encontram do diretorio src/resources/views, sendo elas:

• login.php
• cadastrar.php
• chat.php

Desenvolvedores

• Mateus Pereira
• Jadde Freitas
• Erycles Silva