🚀 dev.api.ppcchoice.ufes.br

📖 Descrição

API RESTful construída para consumo interno do projeto PPC Choice, uma aplicação web de comparação e visualização de Projetos Pedagógicos de Curso e fornece dados dos seguintes recursos:

• Instituições de Ensino (Superior)
• Unidades de Ensino
• Departamentos da unidade de ensino
• Componentes curriculares
• Cursos
• Projetos Pedagógicos de Curso (PPC)

Você pode acessar mais detalhes na seção Documentação

💻 Status do Projeto

🚧 🚀 Em construção ...  🚧

Sumário

• Documentação
• Demonstração
• Problemas
• Contribuição
  • Pré-requisitos e limitações
  • Fork este repositório e realize alterações
  • Planeje e execute testes
  • Solicite a incorporação
• Autores

📚 Documentação da API

Você pode ter acesso a toda documentação da API clicando aqui. Nela constam todas as rotas, parâmetros e suas respectivas restrições.

🕶️ Demonstração da aplicação

Recomendamos o Postman para realização de requisições. Um arquivo inicial com todas as requisições pode ser baixado a seguir.

Baixe os arquivos do Postman

👻 Problemas

Sinta-se à vontade em registrar novos problemas. Caso tenha encontrado a solução, ficaríamos gratos em analisar tal situação.

Caso encontre algum problema, por favor, faça uma issue descrevendo o problema e não se esqueça de incluir as etapas para que possamos reproduzi-lo facilmente.

🎈 Contribuição

Agradecemos seu interesse em contribuir!

Caso você tenha alguma ideia para melhorias, sinta-se a vontade em compartilhar por meio de uma issue, mas não espere uma resposta em tempo hábil.

Guia e protocolo de contribuição:

1. 📌 Pré-requisitos e limitações

Antes de começar, instale e configure as seguintes ferramentas:

• PHP >= 5.3.7
• Git
• Servidor Apache
• Editor de texto de sua preferência (recomendado: VSCode)
• Ferramenta de requisições HTTP (recomendado: Postman)

Alerta: Embora seja recomendado utilizar versões estáveis mais atualizadas da linguagem, é uma imposição do serviço de hospedagem da universidade que a versão do PHP seja 5.3.

2. 🍴 Fork este repositório e realize alterações

• Faça um fork deste repositório.

• Crie um branch para suas mudanças. Isso separa as mudanças no pull request de suas outras mudanças e torna mais fácil editar/corrigir os commits no pull request.

• Edite as alterações e confirme-as localmente.

• Envie-as para o fork do GitHub.

3. 📋 Planeje e execute testes

Nesta etapa recomenda-se que seus testes sejam escritos e executados utilizando a ferramenta PHPUnit e GuzzleHttp . Ah! E não se esqueça de documentar ostensivamente seus testes.

Para executar os testes pré-existentes, execute o seguinte comando na raíz do projeto:

./vendor/bin/phpunit tests

4. ✔️ Solicite a incorporação

• Visite o GitHub e crie uma pull request para solicitar a inclusão de suas alterações no repositório original.
• Descreva suas alterações de forma clara e sucinta no texto da pull request e marque a issue se for o caso.
• Se mais tarde você precisar adicionar novos commits à solicitação pull, você pode simplesmente enviar as alterações para o branch local e usar git push para atualizar automaticamente a solicitação pull.

✏️ Autores

Hádamo Egito

Elyabe Alves

Guilherme Gonçalves

Wellerson Prenholato

Gabriel Lima