Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jefferson-calmon/ecoleta
Projeto criado durante a semana do Next Level Week
https://github.com/jefferson-calmon/ecoleta
Last synced: about 5 hours ago
JSON representation
Projeto criado durante a semana do Next Level Week
- Host: GitHub
- URL: https://github.com/jefferson-calmon/ecoleta
- Owner: jefferson-calmon
- License: mit
- Created: 2020-06-07T20:51:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T03:02:31.000Z (almost 2 years ago)
- Last Synced: 2023-03-07T16:05:42.753Z (over 1 year ago)
- Language: TypeScript
- Size: 2.05 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
:recycle: Ecoleta
Projeto feito com ReactJS & JavaScript na semana do Next Level Week (NLW)
## :open_book: Sobre
Ecoleta é um projeto baseado na NLW. Ele conecta pessoas que querem ou não sabem a maneira certa de descartar o lixo com companhias de reciclagem, descarte de óleo e etc. Esse lixo pode ser pilhas, resíduos orgânicos, óleo e muito mais.
## :artificial_satellite: Tecnologias usadas
* Node.js
* JavaScript/TypeScript
* ReactJS
* React Native
* Expo
## :dart: Como usar
Para usar rodar as aplicações é necessário ter instalado na sua maquina o [Node.js](https://nodejs.org/en/download/) e o [Git](https://git-scm.com/downloads). Depois basta seguir os passos a seguir.
Antes de tudo, é necessário você instalar as dependências. Para isso basta rodar os seguintes comandos em seu terminal/prompt.
```shell
# Vai clonar a pasta do projeto para a sua máquina
git clone https://github.com/jefferson-calmon/ecoleta.git
# Vai abrir a pasta do projeto
cd ecoleta
# Vai abrir um arquivo em lotes e instalar todas as dependências. Esse processo vai demorar um pouco não feche o terminal.
install-dependencies.bat
```
Depois disto vamos iniciar o back-end.
Obs: Caso tenha queira instalar as dependências manualmente, abra o arquivo ```install-dependencies.bat``` dentro da pasta ecoleta e veja as dependências que são necessárias.
### Back-end
Para iniciar o back-end é muito simples. Execute os comandos abaixo.
``` shell
# Abrir a pasta do back-end
cd server
# Iniciar o back-end
npm run dev
# A API estará rodando na porta 3333 em localhost
```
Pronto!! O back-end já está rodando!! Agora você precisa iniciar o Front-end.
### Front-end
Para você poder acessar o site você precisa deixar ele online. Abra outro terminal e navegue até onde está a pasta do projeto ecoleta e execute os comandos abaixo. Obs: Não feche o terminal que está rodando o back-end.
```shell
# Vai abrir a pasta do site
cd web
# Vai iniciar um server local com o site.
npm start
# Depois disto vai abrir um página no seu navegador rodando o site.
```
Pronto!! Agora já temos o back-end e o site funcionando.
### Mobile
Para você testar o app será preciso instalar um app chamado [Expo](https://play.google.com/store/apps/details?id=host.exp.exponent) em seu celular. Ele irá servir como simulador para o app.
Alem disso você também tera que instala o expo-cli em sua maquina. Para isso, execute o seguinte comando.
```shell
npm install expo-cli
```
Depois abra mais um terminal e execute os comandos abaixo.
```shell
# Vai abrir a pasta com os arquivos do mobile
cd mobile
Vai iniciar mais um servidor local
npm start
```
Depois desses comandos ira abrir no seu navegador uma página com algumas informações. Abra o app do expo em seu celular e escaneie o QR code. Proto!! Depois de carregar irá abrir o app.
## License
Este repositório usa a licença MIT. Por favor leia a licença.
Feito por Jefferson Ferrari :bomb: