Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 2.46 KB

README.md

File metadata and controls

83 lines (62 loc) · 2.46 KB

Happy

About   |    Requirements   |    Start   |    Node.js   |    ReactJS   |    React Native

Happy

📃 About

Happy, it's an app for gather people who want to visit and meet children in orphanages. In the app your possible find orphanages based on your location and read about orphanage and create a new appointment.

This repository contains an API REST in Node.js, web application in React JS and a mobile app in React Native.

Node.js: is a REST API that does all the CRUD of the application, data persistence, exception handling and that serves data to both the front-end and the mobile.

ReactJS: application web where the user find orphanages based on your location.

React Native: similar the web application, the mobile app have all features the application web beyond and develop using Expo.

📚 Requirements

  • Have Git to clone the project.
  • Have Node.js installed.
  • Have Yarn installed.
  • Have a mobile device or emulator iOS or Android

🚀 Start

  # Clone the project:
  $ git clone https://github.com/leandro-oliveira83/happy.git

  # Entry on directory:
  $ cd happy

⚙️ Starting back-end

  # Entry on directory backend:
  $ cd backend

  # Install all dependencies:
  $ yarn

  # Run migrations:
  $ yarn typeorm migration:run

  # Run application:
  $ yarn dev:server

💻 Starting front-end

  # Entry on directory web:
  $ cd web

  # Install all dependencies:
  $ yarn

  # Run application:
  $ yarn start

📱 Starting mobile

  # Entry on directory mobile:
  $ cd mobile

  # Install all dependencies:
  $ yarn

  # Run application by Expo:
  $ yarn start