josecage / kallun-api

Plataforma online que agrega gíria/calão de Angola - ideia original de Leocarpo Mário

Kallun

API de gírias de Angola

Requisitos

• PHP 7.1.3
• Laravel 5.7.*
• PHPUnit 7.0
• MySQL 5.7

Instalação

• Faça o clone do repositório para sua máquina:

  git clone https://github.com/JoseCage/kallun-api.git
  

• Entre no directório do projecto

  cd kallun-api
  

• Instale as dependẽncias:

  composer install

Contribuições

• Faça o fork do projeto para a sua conta

• Faça o clone do repositório para sua máquina:

  git clone [email protected]:seunome-do-github/kallun-api.git
  

• Entre no directório do projecto

  cd kallun-api

• Crie um branch baseado no branch develop

  git checkout -b nome-da-feature-nova
  

  Como contribuir

Veja nosso CONTRIBUTING.md

kallun-api's Issues

Registo e Confirmação de conta

Criar a funcionalidade registo e confirmação de contas de utilizador/colaborador.

Perfil de colaboradores

Criar perfil de contribuidores na plataforma.

Estrutura padronizada do projeto

Organizar o repo/projeto em diretórios e ficheiros padronizados. Evitando que cada contribuidor coloque seu código num lugar ou noutro sem organização.

Autenticação por Token

Implementar login com Token na API

Readme.md file missing

Missing a file that explain about de kallun-api works

Endpoints da API

Definir com base nos módulos e funcionalidades definidas, quais endpoints e métodos teremos implementados nos endpoints.

API - rotas

• Autenticação

  • POST: /auth/login Login
  • POST: /auth/register Registo

• Slang

  • GET: /v1/slangs Todas gírias
  • POST: /v1/slangs Adicionar nova gíria

Módulos da app

Definir e estruturar os módulos (Models, Classes) da API.

• User
• Slang

### Fields:

User:

• id (uuid)
• name (string)
• email (string)
• phone (string)
• email_verified_at (timestamp)
• password (string)
• created_at (datetime)
• updated_at (datetime)

Slang:

• id (uuid)
• name (string)
• meaning (string)
• example (text)
• description (text)
• created_at (datetime)
• updated_at (datetime)