BE THE HERO SYSTEM
A system to integrate the people to help Ongs
Built with | How to run | Licence | Get in touch
🚀 Built with
This project was developed with the following technologies:
- Node.js
- Express
- knex
- sqlite3
- axios
- React Native
- Expo
- Expo-Mail-Composer
- React Navigation
- react-native-gesture-handler
- Celebrate
- Jest
- VS Code
ℹ️ How to run
Requirements
To run the app, you will need Git, Node.js v12.13.1 or higher, Npm, SQLite3.
Backend
Now clone the repository and install the dependencies.
# to clone the repository
git clone https://github.com/Evoney/Be-the-hero.git
# go into the backend folder
cd bethehero/backend
#install the backend dependencies
yarn or npm install
In order to connect to the database, you will need to enter the access informations into a .env file, based on a .env.example file that is provided in the backend folder, change the variables according to your environment.
# run migrations
yarn knex migrate:latest
&
npm knex migrate:latest
# run api
yarn dev & npm run devFrontend
# in another tab of the terminal install the frontend dependencies and run it
cd frontend
yarn
yarn start & npm installUse this credentials to access the web application
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
yarnIn order to run the application on your device, you need to change the ip config.
baseURL: 'http://192.168.0.235:3333',replace 192.168.0.235 with your machine's ip.
Now with everything on place, run the application.
# to run the app
npm 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 Samsung J4
📄 License
This project is under the MIT license.
📬 Get in touch!
Made with ☕ and ♥ by Evoney.