https://github.com/lucasmc64/be-the-hero

Be The Hero and help local charities to continue doing good.
https://github.com/lucasmc64/be-the-hero

expo nodejs omnistack omnistack11 react-native reactjs rocketseat sqlite3

Last synced: about 1 month ago
JSON representation

Be The Hero and help local charities to continue doing good.

• Host: GitHub
• URL: https://github.com/lucasmc64/be-the-hero
• Owner: lucasmc64
• License: mit
• Created: 2020-03-23T12:39:27.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-07-11T00:20:43.000Z (over 3 years ago)
• Last Synced: 2023-03-05T20:04:11.727Z (almost 2 years ago)
• Topics: expo, nodejs, omnistack, omnistack11, react-native, reactjs, rocketseat, sqlite3
• Language: JavaScript
• Homepage:
• Size: 1.02 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Be The Hero](readme-images/cover.png)

# :superhero: Be The Hero

> This was a project developed during OmniStack Week 11.0.

## :dart: Goal

At first the project is intended to be a means to help local charities, where they publish a case in which they need help in search of a hero to save them.

## :scroll: Some details

- The back-end is built with Node.JS and SQLite.

- The font-end is built with ReactJS.

- The mobile is built with React Native aided by Expo.

## :thinking: How do I run the project on my machine?

The first step is to clone the project, either via terminal or GitHub Desktop, or even by downloading the compressed file (.zip). After that, go ahead.

### :hammer_and_wrench: Requirements

- [Node.JS](https://nodejs.org/).

- (Optional) [Yarn](https://yarnpkg.com/).

### :mag: Installing dependencies

With Node.JS installed, access each of the directories (**backend**, **frontend** and **mobile**) via terminal and run the `npm install` command. If you prefer to use Yarn, just run the command `yarn`.

### :goggles: Running the Backend

Access the **backend** directory via terminal, run the command `npm start` or ` yarn start` and a message similar to the following will appear for you:

![Result of the command in the terminal](readme-images/backend.png)

> If this was not the result, check that the requirements and previous steps have been met.

### :sparkles: Running the Frontend

Access the **frontend** directory via terminal, run `npm start` or `yarn start`. A message similar to the following will appear for you:

![Result of the command in the terminal](readme-images/frontend.png)

Automatically, in your default browser, a tab will open for the link http://localhost:3000/ (where the project will be running).

> If this was not the result, check that the requirements and previous steps have been fulfilled.

### :iphone: Running Mobile

#### :hammer_and_wrench: Requirements

- Expo app: ([Android](https://play.google.com/store/apps/details?id=host.exp.exponent) - [iOS](https://apps.apple.com/br/app/expo-client/id982107779)).

- [Expo Command Line](https://expo.io/learn).

#### :hiking_boot: Steps

Access the **mobile** directory via terminal and run `npm start` or ` yarn start`.

Then, a message similar to the following will appear for you:

![Expo-cli terminal](readme-images/mobile.png)

Automatically, in your default browser, a tab will open for the link http://localhost:9002/ with the following screen:

![Expo on browser](readme-images/browser-expo.png)

As you can see, there is a QRCode both on the terminal and on the website that opened (they are the same). Now, open the Expo app on your smartphone, scan the QRCode and wait until the project is synchronized.

> If this was not the result, check that the requirements and previous steps have been fulfilled.

## :tada: If everything went well...

Now you are running the project beautifully!

## :memo: License

This project is under the MIT license. See the [LICENSE](LICENSE) for more information.

---

Made with :purple_heart: by Lucas Coutinho :wave: [Get in touch!](https://www.linkedin.com/in/lucasmc64/)