omurilo / BeTheHero

This is Be The Hero, an application coded on Omnistack Week 11, however, i decided to do it using Typescript. His goal is to help ONGs have a place to share their actions that need financial assistance.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BeTheHero

🚧 πŸš€ Semana OmniStack 11.0 In progress.. 🚧

GitHub language count Repository size Made by Murilo Henrique GitHub last commit License Stargazers

Run in Insomnia

Project   |    Technologies   |    Layout   |    How to use   |    License

πŸ’» Project

Be The Hero - An application coded on Omnistack Week 11, however, i decided to do it using Typescript.

His goal is to help ONGs have a place to share their actions that need financial assistance.

The objective for this project was the development of a backend (for the management of all informations), frontend (for ongs to insert their actions) and an mobile app (for all users view and Be The Hero with an action).

πŸš€ Technologies:

✨ JavaScript was the language used throughout the project πŸ’ž
  • Node.js on backend, with a Databases SQLite and PostgreSQL, for development and production environments sucessively.

    • Bull (with Redis) used for queue management (for email service).
    • Bcrypt and JsonWebToken (JWT) for Authentication and Authorization
  • React on frontend and React Native on mobile with Redux, Redux Saga, Redux Sauce and Immutable.js to state management, Style Components and UnForm πŸ’ž to more beautiful interface.

πŸ”– Layout

Para acessar o layout utilize a ferramenta Figma.

ℹ️ How To Use

It is necessary to have

  • Node.js v12+ installed
  • npm or yarn πŸ’ž
  • Android SDK and JDK8+
  • Cocoapods for Mac users
  • Docker and Docker Compose

The first thing is install the dependencies

cd backend && yarn
cd frontend && yarn
cd mobile && yarn

Then, configure environment files

  • backend/.env
  • frontend/src/services/api/index.js
  • mobile/src/services/api/index.js

And let's go!

docker-compose up -d
// on another command line
cd mobile && yarn react-native run-android or yarn react-native run-ios

πŸ“ License

This project is under the MIT license. See the LICENSE for details.


If everything goes well, now the system will be just waiting for you

Made with β™₯ by Murilo Henrique πŸ‘‹ Get in Touch

About

This is Be The Hero, an application coded on Omnistack Week 11, however, i decided to do it using Typescript. His goal is to help ONGs have a place to share their actions that need financial assistance.


Languages

Language:TypeScript 99.6%Language:HTML 0.4%