Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rafaelgoulartb/be-the-hero
🚀 - Be the Hero, um projeto que ajuda pessoas que querem contribuir para ONGs a encontrar uma ONG - feito na Semana OmniStack 11 @Rocketseat
https://github.com/rafaelgoulartb/be-the-hero
backend expo express frontend knex nodejs omnistack react react-native
Last synced: 5 days ago
JSON representation
🚀 - Be the Hero, um projeto que ajuda pessoas que querem contribuir para ONGs a encontrar uma ONG - feito na Semana OmniStack 11 @Rocketseat
- Host: GitHub
- URL: https://github.com/rafaelgoulartb/be-the-hero
- Owner: RafaelGoulartB
- License: mit
- Created: 2020-03-23T11:13:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-27T01:27:46.000Z (almost 3 years ago)
- Last Synced: 2024-05-01T19:25:42.777Z (7 months ago)
- Topics: backend, expo, express, frontend, knex, nodejs, omnistack, react, react-native
- Language: JavaScript
- Homepage:
- Size: 3.64 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Be the Hero
> Project Be The Hero was made using Javascritp Stack(Node.js, React, React Native) in OmniStack's Week 11
# :pushpin: Table of Contents
* [Technologies](#computer-technologies)
* [Features](#rocket-features)
* [How to Run](#construction_worker-how-to-run)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)
# :computer: Technologies
This project was made using the follow technologies:
* [Typescript](https://www.typescriptlang.org/)
* [React](https://reactjs.org/)
* [Expo](https://expo.io/)
* [Express](https://expressjs.com/)
# :rocket: Features
* Website to sign up teachers and students.
* App to connect teachers and students.
# :construction_worker: How to run
```bash
# Clone Repository
$ git clone https://github.com/RafaelGoulartB/be-the-hero.git
```
### 📦 Run API
```bash
# Go to server folder
$ cd be-the-hero/server
# Install Dependencies
$ yarn install
# Run Aplication
$ yarn start
```
Access API at http://localhost:3333/
### 💻 Run Web Project
```bash
# Go to web folder
$ cd be-the-hero/web
# Install Dependencies
$ yarn install
# Run Aplication
$ yarn start
```
Go to http://localhost:3000/ to see the result.
### 📱 Run Mobile Project
To run the mobile project you need a cellphone with the app of [expo](https://play.google.com/store/apps/details?id=host.exp.exponent) instaled or a emulator android/ios.
After, fork this repository and clone to your machine. Inside of the project's folder run the following commands:
```bash
# Go to mobile folder
$ cd be-the-hero/mobile
# Install Dependencies
$ yarn install
# Run Aplication
$ yarn start
```
Aferter read the QRCode with the app of [expo](https://play.google.com/store/apps/details?id=host.exp.exponent) or run on emulator.
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the the [Be The Hero](https://github.com/RafaelGoulartB/be-the-hero/issues) repository. If you already found a solution to your problem, **i would love to review your pull request**!
# :tada: Contributing
Check out the [contributing](./CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
# :closed_book: License
Released in 2020 :closed_book: License
Made with love by [Rafael Goulart](https://github.com/RafaelGoulartB) 🚀.
This project is under the [MIT license](./LICENSE).
Give a ⭐️ if this project helped you!