Giter Club home page Giter Club logo

be-the-hero's Introduction

Be The Hero

Be The Hero - Connect your NGO with people who want to help you.

GitHub top language Made by Repository size GitHub last commit Repository issues GitHub

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

Run in Insomnia

Layout

🦸‍♀️ About the project

Using the web client, the NGOs can create incidents informing about their needs and the amount to solve the incident.

With this informations and using the mobile client, people can help one or more incidents and be the hero for that NGO.

The goal of this project is increase the possibility of to help more cases and faster.

Project Layout Cadastro Login Cadastro de Caso Lista de Casos Mobile

🚀 Technologies

Technologies that I used to develop this api

💻 Getting started

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

Obs.: I recommend use docker

Clone the project and access the folder

$ git clone https://github.com/EliasGcf/be-the-hero.git && cd be-the-hero

Install dependencies

$ yarn

Follow the steps below

Backend

# Create the instance of postgreSQL using docker
$ docker run --name bethehero-postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables
$ cp packages/server/.env.example packages/server/.env

# Once the services are running, create the database inside of container
$ yarn server sequelize db:create

# With the database created, run the migrations
$ yarn server sequelize db:migrate

# To finish, run the api service
$ yarn server dev

# Well done, project is started!

Web

Obs.: Before to continue, be sure to have the API running

# Be sure the file 'packages/web/src/services/api.ts' have the IP to your API

# Start the client
$ yarn web start

Mobile

Obs.: Before to continue, be sure to have the API running

# Be sure the file 'packages/mobile/src/services/api.ts' have the IP to your API

# Start the expo service and scan the QR code with Expo Client
$ yarn mobile expo

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork EliasGcf/be-the-hero

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd be-the-hero

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.


Made with 💜  by Elias Gabriel 👋  See my linkedin

be-the-hero's People

Contributors

dependabot[bot] avatar eliasgcf avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.