StefanoSaffran / be-the-hero

Be The Hero - Application that connects people who wants to help with NGOs.

Be the Hero Fullstack app 🦸‍♂️

💻 Project   |    🚀 Built with   |    ℹ️ Getting Started   |    📃 License   |    📬 Get in touch

💻 Project

Application that connects people who wants to help with NGOs.

🚀 Built with

This project was developed with the following technologies:

• Node.js
• Express
• Nodemon
• ReactJS
• Styled-components
• React Native
• React Navigation
• Redux
• Redux-Saga
• Redux-persist
• React-toastify
• Immer
• Axios
• React-icons
• Reactotron
• Polished
• ESLint
• Prettier
• VS Code

ℹ️ Getting Started

Requirements

To run the app, you will need:

• Git
• Node.js v12.13.1 or higher
• Yarn

Backend

Now clone the repository and install the dependencies.

# to clone the repository
git clone https://github.com/StefanoSaffran/omnistack-11.git

# go into the backend folder
cd omnistack-11/backend

#install the backend dependencies
yarn

# run api
yarn dev

Frontend

# in another tab of the terminal install the frontend dependencies and run it 
cd frontend
yarn
yarn start

Mobile

The Application was developed using Expo. It is a free and open source toolchain built around React Native to facilitate the process of running and testing applications. Click here to get start with Expo.

# install the dependencies
cd mobile
yarn

In order to run the application on your device, you need to change the ip config.

api.js

  baseURL: 'http://192.168.0.185:3003',

replace 192.168.0.185 with your machine's ip.

If you want to use Reactotron change the ip in the Reactotron config file.

ReactotronConfig

  .configure({ host: '192.168.0.185' })

Now with everything on place, run the application.

# to run the app
yarn start

Expo will open a page in your browser, scan the QRcode on the page and wait for the app to load.

The Application was developed and tested on Iphone 6s

---

📄 License

This project is under the MIT license. See the LICENSE for more information

📬 Get in touch

       

---

Made with ☕ and ❤️ by Stefano Saffran.