🚀   Rocketseat Omnistack Week 11

About the project   |    Layout   |    How-to run   |    Routes   |    License

---

🔥   About the project

Be The Hero is a system to helps NGO's to find sponsors. It was created whithin the event Semana OmniStack11 - RocketSeat's in order to put into practice all the content studied during the course.

---

🎨   Layout

See project's layout at be-the-hero-layout. Remember that you will have to login or create an account at Figma.

---

🔌   How-to run

  # BACK-END - Install dependencies
  $ cd backend
  yarn install

  # BACK-END - Run test suits
  yarn test

  # BACK-END - Start application
  yarn dev

  ######

  # FRONT-END-WEB - Install dependencies
  $ cd frontend
  $ yarn start

  # FRONT-END-WEB - Run test suits
  $ yarn test

  # FRONT-END-WEB - Start application
  $ yarn dev

  ######

  # FRONT-END-MOBILE - Install dependencies
  $ cd mobiles
  $ yarn start

  # FRONT-END-MOBILE - Run test suits
  $ yarn test

  # FRONT-END-MOBILE - Start application
  $ expo start

---

🔗   Routes

• User Resources:
  • GET /profile
  • POST /login
• Incidents Resources:
  • POST /incidents
  • DEL /incidents
  • GET /incidents
• Institutes Resources:
  • POST /institutes
  • GET /institutes

More information soon.

---

🚥   Status Codes

Be the hero returns the following status codes in its API:

Status Code	Description
200	OK
422	UNPROCESSABLE ENTITY
400	BAD REQUEST
404	NOT FOUND
500	INTERNAL SERVER ERROR

---

📝   License

MIT License. See the file LICENSE for more details.

---

Developed ✨   by @fabiopicolijr 👉   See my linkedin.