nlw-ecoleta: A TypeScript repository from nlnadialigia

Símbolo verde da reciclagem e o título Ecoleta

🌱 Seu marketplace de coleta de resíduos. Ajudamos pessoas a encontrarem pontos de coleta de forma eficiente. 💚

💻 Sobre o projeto

♻️ Ecoleta - é uma forma de conectar empresas e entidades de coleta de resíduos orgânicos e inorgânicos as pessoas que precisam descartar seus resíduos de maneira ecológica.

Projeto desenvolvido durante a NLW - Next Level Week oferecida pela Rocketseat.

📎 Funcionalidades

      📌 Criação de ponto de coleta
      📌 Listagem de tipos de items
      📌 Listagem de um ponto de coleta específico
      📌 Buscar por ponto de coleta

🎨 Layout

O layout da aplicação está disponível no Figma:

Mobile

Web

🚀 Como executar o projeto

Este projeto é divido em três partes:

Backend (pasta server)
Frontend (pasta web)

💡 O Frontend precisa que o Backend esteja sendo executado para funcionar.

🎲 Rodando o Backend (servidor)

# Clone este repositório
$ git clone git@github.com:nlnadialigia/nlw-ecoleta.git

# Acesse a pasta do projeto no terminal/cmd
$ cd nlw-ecoleta

# Vá para a pasta server
$ cd server

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm run dev

# O servidor inciará na porta:3333 - acesse http://localhost:3333

🪄 Testando os endpoints

A documentação dos endpoints se encontra no arquivo swagger.json

Para testar, com a aplicação rodando, acesse http://localhost:3333/api-docs

🧭 Rodando a aplicação web (Frontend)

# Clone este repositório
$ git git@github.com:nlnadialigia/nlw-ecoleta.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd nlw-ecoleta

# Vá para a pasta da aplicação Front End
$ cd web

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm run start

# A aplicação será aberta na porta:3000 - acesse http://localhost:3000