Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/mtsalcova/livro-sem-apego

:books: Um site de doação de livros, sem fins lucrativos! o/
https://github.com/mtsalcova/livro-sem-apego

frontend gulp pug stylus vuejs2

Last synced: 4 months ago
JSON representation

:books: Um site de doação de livros, sem fins lucrativos! o/

Lists

README

        

# Livro sem Apego

> O [Livro sem Apego](http://livrosemapego.com.br) é um site de doação de livros sem fins lucrativos com objetivo de ajudar alguém que esteja precisando de um livro mas não tem condições de comprá-lo ou simplesmente gostaria de ganhá-lo.

## Estrutura do Projeto

Ao construir o site, utilizamos uma estrutura criada do zero utilizando alguns pré-processadores como **Stylus**, **Pug** e para renderizar alguns componentes **Vue.js**

### Componentes
Para renderizar alguns componentes que precisam de dados do banco de dados, utilizamos **Vue.js**, que foi nossa primeira experiência com uma lib js para criação de componentes, por conta disso não fizemos o site em SPA.

### API

Você conseguirá acessar a API que está online via ```http://localhost:8000```, por tanto qualquer livro cadastrado localmente, irá aparecer no site online e as pessoas poderão visualizar, então cuidado ao criar cadastrar livros de teste. A **documentação** da API está em Desenvolvimento.

### Rodando o Projeto

Para os arquivos estáticos utilizamos o **Gulp.js** como automatizador de tarefas, então para rodar basta acessar o diretório ```src/tools``` e rode os comandos:

```
1. npm install
2. npm run gulp
3. E Acessar http://localhost:8000 :)
```

#### Rodando os componentes

Utilizamos uma template do **vue-cli** com **Browerify** e implementamos em nossa estrutura, então para rodar os componentes basta acessar ```src/vue``` e execute os comandos:

```
1. npm install
2. npm run watchify
```

## Contribua! :)

```
git clone [email protected]:mtsalcova/livro-sem-apego.git
```

Só aceitamos deploy na branch **[dev](https://github.com/mtsalcova/livro-sem-apego/tree/dev)** e antes de fazer o **push**, não se esqueça de executar os comandos nos seguintes diretórios o/:

* **src/tools**
```
npm run gulp build
```
* **src/vue**
```
npm run build
```

## Licença
[MIT Licence](https://github.com/mtsalcova/livro-sem-apego/blob/master/LICENSE) © [Livro sem Apego](http://livrosemapego.com.br)