Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
itbruno committed Mar 28, 2022
1 parent 2057a55 commit f24a807
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
# LinksforAll
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/itbruno/linksforall?label=version)

![GitHub tag (latest SemVer)](https://img.shields.io/github/package-json/v/itbruno/linksforall)

![cover](https://cldup.com/v6OkMOSwGX-2000x2000.jpeg)

## Descrição

**Linksforall** é um agregador de links que pode ser organizado com categorias e com um campo de email para captação/newsletter/etc.

## Arquivos para Download
|UI|HTML/CSS/JS|
|--|-----------|
|Interface criada no Figma: https://tinu.be/uilinks|**.zip** do última versão estável do código: https://github.com/itbruno/linksforall/archive/master.zip|
## Arquivos para Download

| UI | HTML/CSS/JS |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| Interface criada no Figma: https://tinu.be/uilinks | **.zip** do última versão estável do código: https://github.com/itbruno/linksforall/archive/master.zip |

## Setup

Esse projeto está sendo desenvolvido com ReactJS. Para iniciar o projeto, rode o seguinte comando em seu terminal:

```sh
$ yarn install && yarn start
```

## Customização
A UI é separada por temas. Para customizar basta criar um novo tema dentro de `./src/themes/[nome-do-tema]` ou editar algum tema existente.

A UI é separada por temas. Para customizar basta criar um novo tema dentro de `./src/themes/[nome-do-tema]` ou editar algum tema existente.

## Dados

Por enquanto os dados estão mocados, eles podem ser editados dentro do `.js` que está em `./src/services/api/mock.js`. Mas já existe um arquivo para configurar a api quando for criada 😉

## Demo
- [v1.0.1](https://linksforall.surge.sh)
- [v2.0.1](https://linksforall.vercel.app)

- [v1.0.1](https://linksforall.surge.sh)
- [v2.0.1](https://linksforall.vercel.app)

1 comment on commit f24a807

@vercel
Copy link

@vercel vercel bot commented on f24a807 Mar 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.