🚀 Be The Hero

Omnistack Week 11.0

Technologies   |    Installation   |    Remarks   |    Thanks   |    License

This project is an application for nongovernmental organization (NGO) add their projects, incidents and costs, making it available for heroes to donate and help these NGO. The application has an web and a mobile version, using react and react native. The backend was built using node.js.

• Project developed during the Omnistack Week 11.

🕹️ Technologies:

This project used a lot of technologies and concepts. A few of them are listed bellow.

• Node.js
• React
• React Native
• Expo

Also, was used in the project (languages, libraries and frameworks):

• Axios
• Celebrate
• CSS
• Express
• HTML
• Javascript
• Jest
• Knex.js
• SQLite

⏳ Installation:

To install this library, first be sure that you have node and npm installed. They are essencial for running the back and front end. The whole project was made based on Node.js, React and React Native. If you want to use this library, please download all the files and install according to the following steps. Steps

1. In the backend folder, run the command npm install to install all the required packages listed on the file package.json. Note that some packages also have dependencies that are all being installed with this command and are required to the application.
2. After installing the packages, run the command npm start to start the server. This will keep runing until you end the application (Ctrl + C) or close the window that is running. It will not run in the background, so you need to keep the window open.
3. In the frontend folder, run the command npm install, to install the frontend dependencies and after that npm start. Your browser should open a new window/tab with the application runing.
4. For running the mobile part, you first need to install the Expo app in your mobile device. After that, you open the mobile folder of this project and run the command yarn start. It will open a new tab in your browser with a QR code. Use the Expo app to scan the code and it will run the application. Notice that both the backend and the mobile need to use the same network (the application will run without being in the same network, but it won't be able to access the data from the backend).
5. Enjoy the application!

👮 Remarks

Please notice that this project was made during a week, for better understanding the concepts of the node.js, react and react native. This is not a deploy version of the application and may have some bugs. The whole purpose of this code is for learning and I do not have any guaranty if you want to deploy or use it commercially.

🤝 Thanks

I want to thank the Rocketseat team for making these awesome videos and this amazing week, full of knowledge. It help a lot of people to better understand programming and web development. If anyone wants to learn more about them, the link for their website is this. Please notice that the subjects are taught in portuguese (BR).

📝 LICENSE

This project is under the MIT License. For more information, please refer to LICENSE.