Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arrudadev/be-the-hero
Project developed during 11ª OmniStack Week from Rocketseat, for study purposes.
https://github.com/arrudadev/be-the-hero
expo lerna-monorepo nodejs react-native reactjs rocketseat typescript
Last synced: about 1 month ago
JSON representation
Project developed during 11ª OmniStack Week from Rocketseat, for study purposes.
- Host: GitHub
- URL: https://github.com/arrudadev/be-the-hero
- Owner: arrudadev
- License: mit
- Created: 2020-03-29T23:20:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-18T23:00:06.000Z (about 4 years ago)
- Last Synced: 2024-11-14T15:30:08.297Z (3 months ago)
- Topics: expo, lerna-monorepo, nodejs, react-native, reactjs, rocketseat, typescript
- Language: TypeScript
- Homepage:
- Size: 3.34 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
🚀 OmniStack Week 11.0
Technologies |
Overview |
Getting started |
Contributing |
License
[](https://coveralls.io/github/monteiro-alexandre/be-the-hero?branch=master)
[](https://opensource.org/licenses/MIT)
[](http://makeapullrequest.com)
## :rocket: Technologies
This project was developed with the following technologies:
- [Typescript](https://www.typescriptlang.org/)
- [Node.js](https://nodejs.org/en/)
- [React](https://reactjs.org)
- [React Native](https://facebook.github.io/react-native/)
- [Expo](https://expo.io/)
- [Lerna](https://lerna.js.org/)
- [Eslint](https://eslint.org/)
- [Commitlint](https://commitlint.js.org/#/)
- [Knex.Js](http://knexjs.org/)
## 💻 Overview
BeTheHero is a project that aims to connect people who wish to make monetary contributions to NGOs (non-governmental organizations) that need help.
## 📝 Getting started
First you need to have `node` and `yarn` installed on your machine. Then, you can clone this repository.
```bash
git clone https://github.com/monteiro-alexandre/be-the-hero.git
```
Install dependencies:
```bash
yarn
```
Packages dependencies:
```bash
yarn bootstrap
```
## Backend setup
Enter in folder packages/backend and Configure environment variables:
(create .env file based on .env.example)
```bash
# Port that the server is running, example: 3333
SERVER_PORT=3333
```
Run database migrations:
```bash
yarn migrate:latest
```
Start server:
```bash
yarn start
```
## Frontend setup
Enter in folder packages/frontend and Configure environment variables:
(create .env file based on .env.example)
```bash
# backend url
REACT_APP_API_BASE_URL=http://your_machine_ip_address:3333
```
Start aplication:
```bash
yarn start
```
## Mobile setup
Enter in folder packages/mobile and Configure environment variables:
(create environment.ts file based on environment.example.ts)
```js
import Constants from 'expo-constants';
const ENV = {
development: {
apiUrl: 'http://your_machine_ip_address:3333/',
},
staging: {
apiUrl: '',
},
production: {
apiUrl: '',
},
};
const getEnvVars = (env = Constants.manifest.releaseChannel): any => {
let environment;
// What is __DEV__ ?
// This variable is set to true when react-native is running in Dev mode.
// __DEV__ is true when run locally, but false when published.
// eslint-disable-next-line
if (__DEV__) {
environment = ENV.development;
} if (env === 'staging') {
environment = ENV.staging;
} if (env === 'production') {
environment = ENV.production;
}
return environment;
};
export default getEnvVars;
```
Start Expo DevTools:
```bash
yarn start
```
Than you can open the app in your cell phone using the Expo client app for IOS and Android, see:
## 🤔 Contributing
Please read [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on the code of conduct and the process for submitting pull requests.
## :memo: License
This project is under the MIT license. See the archive [LICENSE](LICENSE.md) for more details.