Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wesgtox/be-the-hero
Created on OmniStack Week 11.0.
https://github.com/wesgtox/be-the-hero
android axios celebrate expo expo-mail-composer express heroku intl ios javascript jest netlify nodejs postgresql react react-dom react-icons react-native react-navigation supertest
Last synced: about 21 hours ago
JSON representation
Created on OmniStack Week 11.0.
- Host: GitHub
- URL: https://github.com/wesgtox/be-the-hero
- Owner: WesGtoX
- License: mit
- Created: 2020-03-25T04:22:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-14T12:56:10.000Z (about 3 years ago)
- Last Synced: 2023-03-04T20:48:02.092Z (over 1 year ago)
- Topics: android, axios, celebrate, expo, expo-mail-composer, express, heroku, intl, ios, javascript, jest, netlify, nodejs, postgresql, react, react-dom, react-icons, react-native, react-navigation, supertest
- Language: JavaScript
- Homepage: https://bethehero.wesleymendes.com.br
- Size: 1.7 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
About |
Technology |
Layout |
Getting Started |
Usage |
Roadmap |
Contributing |
License
## About the Project
Be The Hero is a platform to connect NGOs, institutions and volunteers who want to be the hero of a cause.
- Mobile: [Be The Hero on Expo](https://expo.io/@wesgtox/bethehero)
## Technology
This project was developed with the following technologies:
- [Node.js](https://nodejs.org/)
- [Yarn](https://yarnpkg.com/)
- [React](https://reactjs.org/)
- [React Native](https://reactnative.dev/)
- [Expo](https://expo.dev/)
## Layout
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/en/download/)
- [Yarn](https://yarnpkg.com/getting-started/install)
### Install and Run
- Clone the repository:
```bash
git clone https://github.com/WesGtoX/be-the-hero.git
cd be-the-hero/
```
#### Run the API:
1. Install the dependencies:
```bash
yarn install
```
2. Run database migrations:
```bash
npx knex migrate:latest
```
3. Run the API:
```bash
yarn dev
```
4. To run the tests:
```bash
yarn test
```
#### Run the Web Application:
1. Access the Web Application project folder:
```bash
cd frontend/
```
2. Install dependencies:
```bash
yarn install
```
3. Run the Web APP:
```bash
yarn start
```
#### Run the Mobile Application:
1. Access the Mobile project folder:
```bash
cd mobile/
```
2. Install dependencies:
```bash
yarn install
```
3. Run the Mobile APP:
```bash
yarn start
```
#### Building Standalone Apps:
- Android
```bash
expo build:android -t apk
```
- iOS
```bash
expo build:ios
```
**Obs:** If you receive the error: `connect ECONNREFUSED 127.0.0.1: 19001`
> Leave it running in another terminal window:
> ```bash
> expo start
> ```
> Then run the build again.
## Usage
### Routes / Resources
| Method | Endpoint | Description |
| -------- | ---------------- | ------------------------ |
| `POST` | `/sessions` | ONG login. |
| `POST` | `/ongs` | Register a ONG. |
| `GET` | `/ongs` | List all ONGs. |
| `POST` | `/incidents` | Register a incidents. |
| `GET` | `/incidents` | List all incidents. |
| `GET` | `/profile` | List a specific profile. |
| `DELETE` | `/incidents/:id` | Delete a incidents. |
### HTTP methods
- **GET:** _Fetching information from the back-end._
- **POST:** _Create information on the back-end._
- **PUT:** _Changing information on the back-end._
- **DELETE:** _Delete an information on the back-end._
### Parameter types
- **Query Params:** _Named parameters sent on the route after the `?` (Filters, Pagination)._
- **Route Params:** _Parameters used to identify resources._
- **Request Body:** _Request body, used to create or change resources._
### Database
- **SQL:** _MySQL, SQLite, PostgreSQL, Oracle, Microsoft SQL Server._
- **NoSQL:** _MongoDB, CouchDB, etc._
- **Driver:** _SELECT * FROM users._
- **Query Builder:** _table('users').select('*').where()._
## Roadmap
See the [open issues](https://github.com/WesGtoX/be-the-hero/issues) for a list of proposed features (and known issues).
## How to contribute
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project.
2. Create your Feature Branch `git checkout -b feat/my-feature`.
3. Commit your Changes `git commit -m 'feat: My new feature'`.
4. Push to the Branch `git push origin feat/my-feature`.
5. Open a Pull Request.
After the merge of your pull request is done, you can delete your branch.
## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
---
Made with ♥ by [Wesley Mendes](https://wesleymendes.com.br/) :wave: