API para o aplicativo Hush Hush desenvolvido para a disciplina de Programação Mobile 2023/1. Ela é responsável por manipular as entidades referentes e Usuários, Postagens, Comentários e Avaliações.
Elaine Dias Pires 2020101903
Filipe Gomes Arante de Souza 2020100625
- PHP 8.1.23
- Laravel 10.28.0
- PostgreSQL 15
Para rodar o backend, siga os seguintes passos:
- Clonar este repositório localmente;
$ git clone <LINK_REPOSITÓRIO>
- Executar o comando
makepresente no Makefile. Ele roda o backend na porta 8000, portanto certifique-se dela estar disponível;
$ make
Aguarde um pouco e... prontinho! O backend já está em execução.
Para encerrar a aplicação, utilize o comando make down.
$ make down
O Makefile desenvolvido possui comandos além do make e make down, que foram utilizados no tópico anterior. Confira abaixo:
- Gerar o arquivo
.env. Esse comando apenas faz uma cópia do arquivo.env.example;
$ make env
- Importar arquivos de configuração do
vendore geração do.env. Deve ser executado antes de qualquer outro comando:
$ make install
- Sobe os contêineres da API e do Banco de Dados.
$ make up
- Derruba os contêineres da API e do Banco de Dados.
$ make down
- Reseta e insere dados fictícios no Banco de Dados.
$ make seed
- Executa os comandos 2, 3 e 5, respectivamente. Serve para quem quer apenas rodar a aplicação com um único comando.
$ make
Com a API rodando, acesse a URL abaixo para ver detalhes dos endpoints implementados:
Foram criadas as tabelas users, posts, comments e evaluations. Segue abaixo diagrama ER com mais detalhes:
