Happy, find an orphanage nearby.

Index

• About
• Functionalities
• Technologies
• Preview Web
• Preview Mobile
• How to use
• How to contribute

🔖 About

Happy is a web application and mobile to help people find orphanages nearby.

This application was made during the Next Level Week promoted by Rocketseat. The app was made to help people willing to make a good action, visiting an orphanage to support the community. This app will show orphanages nearby. You can also create your own account and add an orphanage that wasn't listed. This registration will be waiting for the administrator to approve. Once approved, the orphanage will be shown to everyone. While awaiting approval, you can edit the info as much you wish.

🎯 Functionalities

• Users:

  • View orphanages.
  • Register orphanages.
  • View registered orphanages by user waiting for approval.
  • Update orphanage detail while waiting approval.
  • Delete orphanage while waiting approval.
  • View registered orphanages accepted by user.

• Admin:

  • View orphanages.
  • Register new orphanages.
  • View all registered orphanages waiting for approval.
  • View all registered orphanages accepted.
  • Accept / Deny orphanages registrations.
  • Delete orphanages.

🚀 Technologies

The project is made with:

• ReactJS
• React Native
• TypeScript
• Node.js
• Express
• SQLite
• Expo
• TypeORM
• Leaflet
• Mapbox
• Multer
• Yup

✔️ 💻 Web

✔️ 📱 Mobile

🔥 How to Use

• Dependencies

  • Is required to install Node.js
  • In order to run scripts and install dependencies you need to install a package manager (ie: NPM).
  • The mobile application requires Expo.
  
  

1. First step, clone this github repository:

  $ git clone https://github.com/dpisati/happy_app.git

2. Run the application:

  # Install dependencies for each folder: mobile, server, web.
  $ cd mobile
  $ yarn install
  $ cd ../server
  $ yarn install
  $ cd ../web
  $ yarn install

  ## Create the database using TypeORM
  $ cd server
  $ yarn typeorm migration:run

  # Start the API
  $ yarn run dev

  # Start the web application
  $ cd web
  $ yarn start

  # Start the mobile app
  $ cd mobile
  $ yarn start

3. Get a token from Mapbox:

The web application requires a token from Mapbox. To be able to get one, you have to create an account and create a new token. This token has to be stored inside the .env file inside the web folder. The key name is: REACT_APP_MAPBOX_TOKEN

Example:

File: happy_app/web/.env

Content:

REACT_APP_MAPBOX_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

♻️ How to Contribute

• Create a Fork from this repo,
• Create a branch with your feature: git checkout -b my-feature
• Commit changes: git commit -m 'feat: My new feature'
• Push to your branch: git push origin my-feature