Projeto Ecoleta

Tem como objetivo manter uma conexão entre empresas e outras entidades que coletam resíduos, resíduos esses (organicos e inorganicos), ajudando pessoas e entidades que necessitam descartar esses materiais "resíduos". Esta solução vêem ajudar a previnir um grander problema que é o descarte inadequado do lixo, onde esta solução também vem ajudar e facílitar o processo de reciclagem e reutilização dos materias coletados.

By Next Level Week da Rocketseat

Projeto Open Source desenvolvido na primeira semana Next Level Week da Rocketseat, com o uso das seguintes tecnologias: TypeScript, Node, Nunjucks.

Desenvolvedor :computer:

Marcos Aurélio

Como Utilizar :keyboard:

Configurações Iniciais

Primeiro, você precisa ter o NodeJS instalado na sua máquina.

Se você estiver utilizando o Linux, você pode optar por instalar o Node através do gerênciador de versões [asdf] para facilitar o processo de mudança da versão do Node, quando for necessário.

Você pode optar também por utilizar o yarn no lugar do npm. Você pode instalar clicando nesse [link][yarn], ou através do [asdf].

Instale as dependências contidas nos arquivos package.json que se encontram na raíz do repositório (para o gerenciamento de commits), no diretório do server, no diretório do website e no diretório mobile. Para instalar as dependências, basta abrir o terminal no diretório e digitar o comando:

$ npm install
# ou
$ yarn

Exemplos:

# Instalando as dependências do server:
$ cd ./sources/server
$ npm install

# Instalando as dependências do website:
$ cd ./sources/website
$ npm install

Veja os arquivos package.json do server e website

Utilizando o Website

# Abrindo o terminal no diretório do website:
$ cd ./sources/website

# Executando o website no modo de desenvolvimento:
$ npm start

Se o browser não abrir automaticamente, acesse: http://localhost:3000.

* Lembre de inserir no arquivo .env o IP exato que foi gerado pelo seu mobile após utilizar o comando npm run start.

Como Contribuir :octocat:

• Verifique as Issues que estão abertas e se já não existe alguma com a sua feature;
• Abra uma Issue com o nome e descrição da sua feature e assine com o seu usuário informando que irá fazê-la;
• Faça um fork do repositório;
• Entre no sua página do GitHub e faça um clone do seu fork;
• Crie uma branch com o nome da sua feature: git chechout -b feat/minhaFeature;
• Faça as alterações necessárias no código ou na documentação;
• Instale as dependências do commitlint na raíz do projeto para a verificação dos commits: npm install ou yarn;
• Faça o commit das suas alterações seguindo as convenções de commit, adicione na descrição o id da sua Issue em parênteses e lembre de fechar a sua Issue com o id no rodapé do commit:

  <tipo>(escopo opcional): <descrição> (#x)

  [corpo do commit]

  Close #x

Exemplo:

  feat: adicionado componente para tal coisa (#52)

  Foi adicionado um componente para tal coisa com o objetivo de melhorar tal coisa, deixando o projeto de tal maneira.

  Close #52

• Faça um push para a sua branch: git push origin feat/minhaFeature;
• Agora é só abrir um pull request no repositório que você fez o fork e assim que acontecer o merge sua Issue será fechada e suas alterações irão fazer parte do projeto;
• Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

Licença :bookmark_tabs:

Esse repositório está licenciado pela MIT LICENSE. Para mais informações detalhadas, leia o arquivo LICENSE contido nesse repositório.