https://github.com/roziscoding/link-ai

https://github.com/roziscoding/link-ai

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/roziscoding/link-ai
• Owner: roziscoding
• License: gpl-3.0
• Created: 2023-08-13T01:29:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-17T14:06:36.000Z (3 months ago)
• Last Synced: 2024-10-12T13:28:00.366Z (2 months ago)
• Language: Vue
• Homepage: https://link-ai-one.vercel.app
• Size: 365 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Linkaí - Encurtador e Agregador de Links

O Linkaí permite criar uma página ao estilo linktree, além de encurtar links

arbitrários não públicos. A ferramenta possui um score de 100 em todas as

categorias do Google Lighthouse e pode ser customizada através de variáveis de

ambiente, além de ser facilmente instalável em ambientes serverless como vercel,

deno deploy, cloudflare workers e afins.

## Instalação

O passo a passo varia de acordo com a plataforma de deploy escolhida mas, em geral, segue a seguinte fórmula:

1. Adicionar o repositório como um novo projeto à plataforma de sua escolha

2. Definir as variáveis de ambiente conforme a seguir:

    - `NUXT_LINK_TREE_PAGE_TITLE`: Título da página, utilizado na tag `` e no título exibido em redes sociais

    - `NUXT_AVATAR_URL`: URL da imagem exibida na landing page

    - `NUXT_TITLE`: Título exibido na landing page

    - `NUXT_SUBTITLE`: Subtítulo exibido na landing page

    - `NUXT_AUTH_GITHUB_SECRET`: App Secret para autenticação com o github

    - `NUXT_AUTH_GITHUB_ID`: App ID para autenticação com o github

    - `NUXT_AUTH_SECRET`: String aleatória utilizada como secret para gerar o JWT

    - `AUTH_ORIGIN`: URL onde a aplicação será deployada

    - `NUXT_ADMIN_EMAILS`: Emails autorizados a acessar o painel administrativo (separados por vírgula)

    - `NUXT_DB_URI`: URI do mongodb para armazenamento do link

    - `NUXT_HTML_LANG`: Idioma a ser utilizado no atributo `lang` da tag ``

3. Acessar o caminho `/admin` na aplicação deployada

4. Cadastrar os links

5. Pronto :D

## Contribuindo

1. Clone o repositório

2. Utilize `npm i` para instalar as dependências do projeto

3. Realize as alterações

4. Teste manualmente

5. Realize um ou mais commits seguindo os padrões do conventional commits

6. Abra o PR

Siga todos os padrões que conseguir observar e garanta que o código está legível e fácil de manter.

## Licença

Código disponibilizado nos termos da GPL-3.0.