Skip to content

Commit

Permalink
Update README.md + Add LICENSE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gustavofsa committed Jun 10, 2020
1 parent e2198c2 commit fd04dec
Show file tree
Hide file tree
Showing 5 changed files with 115 additions and 3 deletions.
Binary file added .github/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions .github/logo-nlw.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
MIT License

Copyright (c) 2020 Gustavo Farias

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
100 changes: 97 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,106 @@
# ♻️ Ecoleta ♻️
<h3 align="center">
<img alt="Logo" title="#logo" width="300px" src=".github/logo.png">
<br><br>
<br>
</h3>

<p align="center">
<a href="https://www.linkedin.com/in/gustavofsa/">
<img alt="Made by GustavoFarias" src="https://img.shields.io/badge/made%20by-GustavoFarias-%2304D361">
</a>

<a aria-label="Completed" href="https://nextlevelweek.com/aulas/booster/1/edicao/1">
<img src="https://img.shields.io/badge/NLW-done-brightgreen?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAMAAAAoLQ9TAAAALVBMVEVHcExxWsF0XMJzXMJxWcFsUsD///9jRrzY0u6Xh9Gsn9n39fyMecy0qd2bjNJWBT0WAAAABHRSTlMA2Do606wF2QAAAGlJREFUGJVdj1cWwCAIBLEsRU3uf9xobDH8+GZwUYi8i6ucJwrxKE+7D0G9Q4vlYqtmCSjndr4CgCgzlyFgfKfKCVO0LrPKjmiqMxGXkJwNnXskqWG+1oSM+BSwD8f29YLNjvx/OQrn+g99oQSoNmt3PgAAAABJRU5ErkJggg=="></img>
</a>

<a href="https://github.com/DanielObara/NLW-1.0/commits/master">
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/gustavofsa/Ecoleta">
</a>

<img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen">
</p>

## 📖 Sobre
Ecoleta é uma aplicação desenvolvida para ajudar a conectar pessoas e empresas em prol da coleta de lixo para reciclagem. O projeto foi desenvolvido durante à semana do meio ambiente e ressalta a importância da sustentabilidade.
Ecoleta é uma aplicação desenvolvida para ajudar a conectar pessoas e empresas em prol da coleta de lixo para reciclagem.

## :rocket: Tecnologias
- [Typescript](https://www.typescriptlang.org/)
- [Node.js](https://nodejs.org/en/)
- [ReactJS](https://pt-br.reactjs.org/)
- [React](https://pt-br.reactjs.org/)
- [React Native](https://reactnative.dev/)
- [Express](https://expressjs.com/pt-br/)
- [Expo](https://expo.io/)

## 🔥 Resultado
Você pode conferir o Layout da aplicação no [Figma](https://www.figma.com/file/1SxgOMojOB2zYT0Mdk28lB/Ecoleta)

![WebDemo](.github/demo.gif)

<br />

## 🤔 Como usar

### **Pré-requisitos**

- É **necessário** possuir o **[Node.js](https://nodejs.org/en/)** instalado na máquina
- Também, é **preciso** ter um gerenciador de pacotes seja o **[NPM](https://www.npmjs.com/)** ou **[Yarn](https://yarnpkg.com/)**.
- Por fim, é **essencial** ter o **[Expo](https://expo.io/)** instalado de forma global na máquina

1. Faça um clone :

```sh
$ git clone https://github.com/gustavofsa/Ecoleta.git
```

2. Executando a Aplicação:

```sh
# Instale as dependências
$ npm install

## Crie o banco de dados
$ cd server
$ npm run knex:migrate
$ npm run knex:seed

# Inicie a API
$ npm run dev

# Inicie a aplicação web
$ cd web
$ npm start

# Inicie a aplicação mobile
$ cd mobile
$ npm start
```

## 🎯 Desafios

- [ ] Listar pontos de coleta criados
- [ ] Editar ponto de coleta
- [ ] Deletar ponto de coleta

## :recycle: Como contribuir

- Faça um Fork desse repositório,
- Crie uma branch com a sua feature: `git checkout -b my-feature`
- Commit suas mudanças: `git commit -m 'feat: My new feature'`
- Push a sua branch: `git push origin my-feature`

<br/>

<h2 align="center">
<img alt="NextLevelWeek" title="#NextLevelWeek" src=".github/logo-nlw.svg" width="150px" />
</h2>

Projeto desenvolvido durante a trilha Booster da Next Level Week #1 oferecida pela [Rocketseat](https://www.rocketseat.com.br).

## 📝 Licença
Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE.md) para mais detalhes.

---

<h4 align="center">
Feito com 💜 by <a href="https://www.linkedin.com/in/gustavofsa/" target="_blank">Gustavo Farias</a>
</h4>

0 comments on commit fd04dec

Please sign in to comment.