/happy

Aplicação desenvolvida durante a 3ª Edição da Next Level Week, promovida pela Rocketseat

Primary LanguageTypeScript

😀 Happy

Aplicação desenvolvida durante a 3ª Edição da Next Level Week, promovida pela Rocketseat.

Aplicação sem fins comerciais, apenas didáticos.

❓ O que é?

O Happy é uma aplicação com o objetivo de agregar informações sobre Orfanatos, para que as pessoas possam visitar, e levar alegria para as crianças.

🖼️ Layout

Você pode conferir o Layout desenvolvido por Tiago Luchtenberg, no Figma:

💿 Instalação

⚠️ Você deve ter o Git instalado em sua máquina

⚠️ Você deve ter o Node instalado em sua máquina

⚠️ Você deve ter o Expo Cli instalado em sua máquina

Caso, você queira, você pode instalar o Yarn em sua máquina

  • Back-end

    1. Primeiramente, você deve clonar este repositório para sua máquina, com o seguinte comando, no terminal:
    git clone https://github.com/deboralbarros/happy
    1. Entre na pasta backend e instale as dependências:
    cd backend

    npm install

    ou, caso você tenha instalado o Yarn:

    yarn install
    1. Inicie o banco de dados, com o seguinte comando:
    npx typeorm migration:run

    ou, caso você tenha instalado o Yarn:

    yarn typeorm migration:run
    1. Troque o ip que está no arquivo ImagesView.ts, (backend/src/views/ImagesView.ts) na linha 7, pelo ip da sua máquina.

    Caso você não saiba o seu ip, você pode seguir as seguintes instruções:

  • Front-end

    1. Entre na pasta web e instale as dependências:
    cd ../web

    npm install

    ou, caso você tenha instalado o Yarn:

    yarn install

  • Mobile

    1. Entre na pasta mobile e instale as dependências:
     cd ../mobile

    npm install

    ou, caso você tenha instalado o Yarn:

    yarn install
    1. Troque o ip que está no arquivo api.ts, (mobile/src/services/api.ts) na linha 4, pelo ip da sua máquina.

    🚀 Rodando

    1. Para rodar o back-end, execute:
    cd ../backend

    npm run dev

    ou, caso você tenha instalado o Yarn:

    yarn dev

    1. Para rodar o front-end: em outro terminal, na pasta raiz do projeto, execute:
    cd web

    npm run start

    ou, caso você tenha instalado o Yarn:

    yarn start

    1. Para rodar o projeto no seu celular, você deve instalar o Expo, no seu celular:
  • No Android
  • No iOS

    1. Em outro terminal, na pasta raiz do projeto, execute:
    cd mobile

    npm run start

    ou:

    expo start

    ou, se preferir usar o Yarn:

    yarn start

    1. Em seu celular, no aplicativo Expo, aperte em 'Scan QR Code' e escaneie o QR Code que aparecer no terminal, ou na página que abriu em seu navegador.

    👩‍💻 Tecnologias utilizadas

    • Typescript - Superset do Javascript, adicionando tipagem estática e outros benefícios
    • ReactJs - Biblioteca para desenvolvimento do front-end web
    • React Native - Biblioteca para desenvolvimento de aplicativos mobile
    • Expo - Ferramenta para auxiliar no desenvolvimento do app mobile
    • NodeJs - Ambiente de execução Javascript fora do navegador
    • ExpressJs - Framework para aplicações web NodeJs
    • SQLite - Banco de Dados
    • Entre outras