README.md

Help save the environment

Index

• About
• Tecnology
• How to use
• How to contribute

🔖 About

The Recicle is an app to help raise awareness about the impacts of waste on the environment.

This application has four main focuses to help people to preserve the environment: identification of garbage by image processing, tips for recycling and reusing garbage, consultation of nearby collection points and visualization of personal progress and impact caused.

🚀 Tecnology

The project was developed using the following technologies

• Javascript
• Node.js
• React Native
• Firebase
• IBM Cloud

✔️ 📱 Mobile

• The layout is avaible on Figma;

🔥 How to use

• Requeriments

  • It is necessry to have the Node.js instaled in the PC.
  • Also, it is needed to have ter um a package manager be the NPM or the Yarn.
  • Lastly it is essential to have an account on Firebase to create your own database.

1. Make a clone :

  $ git clone https://github.com/carolquiterio/recicle.git

2. Execute the aplication:

  # Install the dependencies
  $ npm install

  # Start the aplication
  $ cd mobile
  $ npx start
  $ npx react-native run-android

🤔 How to contribute

• Fork this repository;
• Create a branch with your feature: git checkout -b my-feature;
• Make a commit with your changes: git commit -m 'feat: My new feature';
• Make a push to your branch: git push origin my-feature.

After the merge of your pull request you can delete your branch.

📝 License

This project has the MIT license. See the archive LICENSE for more details.

Made with 💜 by Carol, Mishelle and Chris