0.2.0 • Published 5 years ago

atlantis-auth v0.2.0

Weekly downloads
12
License
-
Repository
-
Last release
5 years ago

Utilização

Requisitos

Para utilizar os componentes o projeto deve respeitar os seguintes requisitos:

  • Vue 2.x
  • Vuetify 2.x
  • Vue router
  • Material Design Icons

Instalação

  1. Adicione a dependencia yarn add atlantis-auth

  2. Configure o plugin:

// ./plugins/atlantis.js
import Vue from "vue";
import VueAtlantisComponents from "atlantis-auth";
import {
  CLIENT_ID,
  ATLANTIS_URL
} from "@/constants/env.constant";
import store from '@/store';
import router from '@/router';
import api from '@/api';

Vue.use(VueAtlantisComponents, {
  clientId: CLIENT_ID,
  atlantisUrl: ATLANTIS_URL,
  privateRoute: "private",
  publicRoute: "public",
  store,
  router,
  axiosInstance: api,
  lang: "pt-BR"
});
  • O módulo AtlantisAuthModule será instalado automaticamente no seu store;
  • Sua rota 'private' e todos seus filhos irão executar o AtlantisPrivateGuard;
  • Sua rota 'public' e todos seus filhos irão executar o AtlantisPublicGuard;
  • Configura interceptors na instancia do axios;
  1. Importe o arquivo criado em main.js
import "./plugins/atlantis";
  1. Adicione o mixin de resposta do código na view pública (landing neste caso):
<script>
import { AtlantisVertifyCodeMixin } from "atlantis-auth";

export default {
  mixins: [AtlantisVertifyCodeMixin],
  ...
};
</script>
  1. Adicione os componentes no arquivo /plugins/vuetify.js.
import Vuetify, {
  VIcon,
  VMenu,
  VAvatar,
  VSubheader,
  VList,
  VListItem,
  VListItemAvatar,
  VListItemContent,
  VListItemTitle,
  VListItemSubtitle,
  VDivider
} from "vuetify/lib";

Vue.use(Vuetify, {
  components: {
    VIcon,
    VMenu,
    VAvatar,
    VSubheader,
    VList,
    VListItem,
    VListItemAvatar,
    VListItemContent,
    VListItemTitle,
    VListItemSubtitle,
    VDivider
  }
});

Componentes

AtlantisLoginBtn

Botão que redireciona o usário o Atlantis.

<template>
  <AtlantisLoginBtn />
</template>

<script>
import { AtlantisLoginBtn } from "atlantis-auth";

export default {
  components: {
    AtlantisLoginBtn
  }
};
</script>

AtlantisAccount

Exibe o avatar e menu com dados da conta e links de logout e configuração de conta.

<template>
 <AtlantisAccount />
</template>


<script>
import { AtlantisAccount } from "atlantis-auth";

export default {
  components: {
    AtlantisAccount
  }
};
</script>

Modules

AtlantisAuthModule

TODO

Guards

AtlantisPrivateGuard

TODO

AtlantisPublicGuard

TODO

Mixins

AtlantisVertifyCodeMixin

TODO


Desenvolvimento

Compilar

yarn run build

Lints and fixes files

yarn run lint