Code Monkey home page Code Monkey logo

be-the-hero's Introduction

Be The Hero

Be The Hero - Conecte sua ONG com pessoas que desejam lhe ajudar.

Node.js CI GitHub top language Repository size GitHub last commit Repository issues License

Run in Insomnia

About   |    Preview   |    Technologies   |    How to use   |    License

🎯 About

Projeto desenvolvido durante a décima primeira edição da Semana OmniStack, promovida pela Rocketseat!:rocket:

Basicamente, o projeto conecta ONGs com pessoas que querem ajudar.

As ONGs registram os casos / incidentes por meio da web e as pessoas visitam o aplicativo mobile, considerando entrar em contato com a ONG por e-mail ou whatsapp para ajudar, tornando-se o herói deste caso.

📷 Preview

     

       

💻 Technologies

Backend
Frontend web
Mobile

🚀 How to use

First of all you need to have node and npm(or yarn) installed on your machine. If you decide to use npm don't forget to delete yarn.lock in folders

Install Node.js v12.x LTS

macOS using Homebrew: brew install node@12

Windows using Chocolately and PowerShell: choco install nodejs-lts

Linux distributions: See Node.js docs

Then you can clone the repository.

git clone https://github.com/azagatti/be-the-hero

First start the application backend.

  1. cd backend
  2. yarn or npm install
  3. yarn start or npm start

Now starting the web application.

  1. cd frontend
  2. yarn or npm install
  3. yarn start or npm start

Starting the application with Expo.

  1. cd mobile
  2. yarn or npm install
  3. yarn start or npm start
  4. Press on Run on Android device/emulator or Run on iOS simulator
  5. Another option is to install Expo on your phone and scan the QRCode.

🔧 How can I contribute?

  • Fork this repository;
  • Create a branch with your feature: git checkout -b minha-feature;
  • Commit your changes: git commit -m 'feat: Minha nova feature :tada:';
  • Push it to your branch: git push origin minha-feature.

After merging your pull request, your branch can be deleted;

📝 License

This project is under MIT. See at here LICENSE for more informations.


Made by ❤️ by Leonardo do Nascimento

be-the-hero's People

Contributors

dependabot[bot] avatar leonardondev avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.