Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andersondev96/semanaomnistack11
Código produzido durante a Semana OmniStack 11.0
https://github.com/andersondev96/semanaomnistack11
javascript nodejs reactjs reactnative rocketseat semanaomnistack11
Last synced: 10 days ago
JSON representation
Código produzido durante a Semana OmniStack 11.0
- Host: GitHub
- URL: https://github.com/andersondev96/semanaomnistack11
- Owner: andersondev96
- License: mit
- Created: 2020-03-25T19:55:01.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T01:50:32.000Z (almost 2 years ago)
- Last Synced: 2024-11-08T11:06:38.681Z (2 months ago)
- Topics: javascript, nodejs, reactjs, reactnative, rocketseat, semanaomnistack11
- Language: JavaScript
- Homepage:
- Size: 5.23 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 50
-
Metadata Files:
- Readme: README-en.md
- License: LICENSE.md
Awesome Lists containing this project
README
🚀 OmniStack Week 11.0
Technologies |
Project |
Layout |
How to execute the project |
How to contribute |
License
## :rocket: Technologies
This project was developed with the following technologies:
- [Node.js](https://nodejs.org/en/)
- [React](https://reactjs.org)
- [React Native](https://facebook.github.io/react-native/)
- [Expo](https://expo.io/)
## 💻 Project
BeTheHero is a project that aims to connect people who wish to make monetary contributions to NGOs (non-governmental organizations) that need help.
## 🔖 Layout
You can view the project layout in the format through [this link](https://www.figma.com/file/2C2yvw7jsCOGmaNUDftX9n/Be-The-Hero---OmniStack-11?node-id=37%3A394).
Remembering that you will need to have an account at [Figma](http://figma.com/).
## 🚀 How to execute the project
This project is divided into three parts:
1. Backend (pasta backend)
2. Frontend (pasta frontend)
3. Mobile (pasta mobile)
💡 Both Frontend and Mobile need the Backend to be running to work.
### Prerequisites
Before you begin, you will need to have the following tools installed on your machine:
[Git](https://git-scm.com), [Node.js](https://nodejs.org/en/), [Expo-Cli](https://docs.expo.io/workflow/expo-cli/).
You will also need to have the Expo application installed on your [Android](https://play.google.com/store/apps/details?id=host.exp.exponent&hl=pt_BR)
or [IOS](https://apps.apple.com/us/app/expo-client/id982107779).
In addition, it is good to have an editor to work with the code like [VSCode](https://code.visualstudio.com/)
#### 🎲 Running the Backend (servidor)
```bash
# Clone this repository
$ https://github.com/AndersonUfop/semanaomnistack11
# Access the project folder in the / cmd terminal
$ cd semanaomnistack11
# Go to the backend folder
$ cd backend
# Install the dependencies
$ npm install
# Run the application in development mode
$ npm run start
# The server will start at port: 3333 - go to http: // localhost: 3333
```
#### 🧭 Runing the web application (Frontend)
```bash
# Clone this repository
$ git clone https://github.com/AndersonUfop/semanaomnistack11
# Access the project folder in your terminal / cmd
$ cd semanaomnistack11
# Go to the Front End application folder
$ cd frontend
# Install the dependencies
$ npm install
# Run the application in development mode
$ npm run start
# The application will open on the port: 3000 - go to http: // localhost: 3000
```
#### 📱 Running the application (Mobile)
``` bash
# Clone this repository
$ git clone https://github.com/AndersonUfop/semanaomnistack11
# Access the project folder in your terminal/cmd
$ cd semanaomnistack11
# Go to the Front End application folder
$ cd mobile
# Install the dependencies
$ npm install
# Run the application in development mode
$ expo start
# With the Expo open on your cell phone, read the QR Code that will appear on the page that was opened,
# wait for the application to run on your phone.
```
## 🤔 How to contribute
- Fork this repository;
- Create a branch with your feature: `git checkout -b my-feature`;
- Commit your changes: `git commit -m 'feat: My new feature'`;
- Push to your branch: `git push origin my-feature`.
After the merge of your pull request is done, you can delete your branch.
## :memo: License
This project is under license [MIT](./LICENSE.md).
Made with ❤️ by Anderson Fernandes 👋🏽 [Get in touch!](https://www.linkedin.com/in/anderson-fernandes-8b5a50135/)
---
## README versions
[Portuguese 🇧🇷](./README.md) | [English 🇺🇸](./README-en.md)