Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ccuffs/id-uffs-avatar
Sistema web similiar ao Gravatar para facilitar a disponibilização de imagens de perfil vinculadas ao idUFFS.
https://github.com/ccuffs/id-uffs-avatar
avatar gravatar laravel microservice php
Last synced: about 2 months ago
JSON representation
Sistema web similiar ao Gravatar para facilitar a disponibilização de imagens de perfil vinculadas ao idUFFS.
- Host: GitHub
- URL: https://github.com/ccuffs/id-uffs-avatar
- Owner: ccuffs
- License: mit
- Created: 2020-04-03T21:12:16.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-17T16:38:20.000Z (almost 2 years ago)
- Last Synced: 2023-02-26T17:55:55.352Z (almost 2 years ago)
- Topics: avatar, gravatar, laravel, microservice, php
- Language: PHP
- Homepage:
- Size: 910 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# id-uffs-avatar
Micro-serviço web para mostrar imagens de perfil a partir do idUFFS de um usuário da [Universidade Federal da Fronteira Sul](https://www.uffs.edu.br). A ideia é ter o mínimo de atrito (e esforço) para mostrar uma imagem de avatar de um usuário que possua um idUFFS, ao estilo do serviço [Gravatar](https://gravatar.com).
## ✨ Uso do serviço
Se você está construindo um serviço web para a UFFS e gostaria de mostrar o avatar de um usuário que tenha um idUFFS, basta criar uma imagem da seguinte forma:
```html
```
onde `{iduffs}` deve ser substituído pelo idUFFS do usuário em questão. Por exemplo, para o usuário cujo idUFFS é `fernando.bevilacqua`, a URL do avatar é:
```html
```
> *DICA*: se estiver usando [Tailwind](https://tailwindcss.com), use o seguinte: ``.
Usuários do seu serviço podem acessar [cc.uffs.edu.br/avatar](https://cc.uffs.edu.br/avatar) para conferir sua imagem de perfil ativa.
## 🚀 Desenvolvimento
Se você planeja trabalhar para evoluir essa ferramenta, siga as intruções abaixo. Você precisará do seguinte já instalado:
- [PHP](https://www.php.net/downloads);
- [Composer](https://getcomposer.org/download/);
- [Node e NPM](https://nodejs.org/en/);
### 1. Clonando o repositório
```
git clone https://github.com/ccuffs/id-uffs-avatar && cd id-uffs-avatar
```
### 2. Configuração do Laravel
Crie um arquivo chamado `.env` utilizando `.env.example` como template:
```
cp .env.example .env
```
> Se você seguir os passos aqui descritos e a aplicação não rodar como esperado, deixe o campo `APP_URL` vazio no `.env`.
O valor do campo `DB_CONNECTION` já estará configurado para `sqlite`, o que fará a aplicação utiliar um banco local SQLite no caminho `/database/database.sqlite`.
Agora, instale as dependências do PHP:
```
composer install
```
Após, uma chave da aplicação deve ser gerada:
```
php artisan key:generate
```
Por fim, rode as migrações, para carregar as relações no banco:
```
php artisan migrate
```
Se houver seeders para o banco de dados, rode:
```
php artisan db:seed
```
### 3. Configuração do Node
Para o front-end, basta instalar as dependências com o `npm`:
```
npm install
```
### 4. Rodando o Projeto
Inicie o servidor Laravel
```
php artisan serve
```
E compile o front-end:
```
npm run dev
```
## 🤝 Contribua
Sua ajuda é muito bem-vinda, independente da forma! Confira o arquivo [CONTRIBUTING.md](CONTRIBUTING.md) para conhecer todas as formas de contribuir com o projeto. Por exemplo, [sugerir uma nova funcionalidade](https://github.com/ccuffs/id-uffs-avatar/issues/new?assignees=&labels=&template=feature_request.md&title=), [reportar um problema/bug](https://github.com/ccuffs/id-uffs-avatar/issues/new?assignees=&labels=bug&template=bug_report.md&title=), [enviar um pull request](https://github.com/ccuffs/hacktoberfest/blob/master/docs/tutorial-pull-request.md), ou simplemente utilizar o projeto e comentar sua experiência.
Veja o arquivo [ROADMAP.md](ROADMAP.md) para ter uma ideia de como o projeto deve evoluir.
## 🎫 Licença
Esse projeto é licenciado nos termos da licença open-source [MIT](https://choosealicense.com/licenses/mit) e está disponível de graça.
## Changelog
Veja todas as alterações desse projeto no arquivo [CHANGELOG.md](CHANGELOG.md).
## Projetos semelhantes
Abaixo está uma lista de links interessantes e projetos similares:
- [Gravatar](https://gravatar.com)