next-level-week-1: A TypeScript repository from frontendwes

🚀 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. O NLW é uma experiência online com muito conteúdo prático, desafios e hacks onde o conteúdo fica disponível durante uma semana.

🎨 Interface

UI completa: Figma

👾 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

💻 Manual para execução

Pré-requisitos

É necessário possuir o Node.js instalado no computador
É necessário possuir o Git instalado e configurado no computador
Também, é preciso ter um gerenciador de pacotes seja o NPM ou Yarn.
Por fim, é essencial ter o Expo instalado de forma global na máquina

Como executar

Podemos considerar este projeto como sendo divido em três partes:

1. Back End (pasta backend)
2. Front End (pasta web)
3. Mobile (pasta mobile)

Tanto o Front-End quanto o Mobile precisam que o Back-End esteja sendo executado para funcionar.

1. Clone o repositório

# Clone este repositório
$ git clone https://github.com/WesleyMarquesGit/Ecoleta.git

2. Rode o servidor (Back-End)

# Acesse a pasta do projeto no terminal/cmd
$ cd Ecoleta/backend

# 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

3. Rodando a aplicação web (Front-End)

# Acesse a pasta do projeto no seu terminal/cmd
$ cd Ecoleta/web

# Instale as dependências
$ npm install

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

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

4. Rodando a aplicação mobile

# Acesse a pasta do projeto no seu terminal/cmd
$ cd Ecoleta/mobile

# Instale as dependências
$ npm install

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

Como contribuir para o projeto

# Faça um fork do projeto.

# Crie uma nova branch com as suas alterações
$ git checkout -b my-feature

# Salve as alterações e crie uma mensagem de commit contando o que você fez
$ git commit -m "feature: My new feature"

# Envie as suas alterações
$ git push origin my-feature