Skip to content

Latest commit

 

History

History
219 lines (159 loc) · 7.65 KB

README.md

File metadata and controls

219 lines (159 loc) · 7.65 KB
Be the hero

A platform to help ONGs raise funds to solve cases

Made by William Jesus Language count License


BeTheHero

Esse projeto foi desenvolvido durante a Semana Omnistack 11.0 da Rocketseat que durou de 23/03 a 28/03/2020. O projeto será frequentemente atualizado com novas features para fixação de conteúdo e upgrade das minhas skills.

Instalação

Para instalar as dependências e executar o Servidor (modo desenvolvimento), clone o projeto em seu computador efetue uma cópia do arquivo .env.example e renomeie como .env no backend, faça as alterações necessárias e em seguida execute (à partir do root do projeto):

cd backend
yarn install
yarn dev

Para iniciar o Frontend do React utilize o comando (à partir do root do projeto):

cd frontend
yarn install
yarn dev

É possivel ainda na raiz do projeto iniciar os seguintes comandos:

Função Description
yarn install:yarn Instalar as dependencias de todos os projetos.
npm install:npm Instalar as dependencias de todos os projetos.
yarn start Iniciar os projetos em modo de desenvolvimento.

Assim que o processo terminar, automaticamente será aberta no seu navegador a página localhost:3000 contendo o Projeto desenvolvido até agora (Dia 5 de 5).

Backend

Veja mais em backend/README.md para informações sobre o servidor e sua arquitetura.

Imnsonia

Para testar a API do BeTheHero, baixe e instale o Insomnia e em seguida clique na Workspace → Import/Export → Import Data → From File → e selecione o arquivo Insomnia.json. Assim que terminar, o resultado ficará assim:

Run in Insomnia

Frontend

Veja o projeto rodando em https://williamjesusdev.github.io/BeTheHero ou em frontend/README.md para informações sobre client Web e os padrões.

Light Theme



Dark Theme


Mobile

Veja mais em mobile/README.md para informações sobre client Mobile e os padrões.

Telas

Light Theme <---------- ----------> Dark Theme


Abra o projeto mobile utilizando Expo


Snapshots

Veja também as capturas te tela de todos os projetos.

CRONOGRAMA

  • Aula 01 - 23/03

    • bate-papo sobre a stack Node | React | React Native
    • informações sobre o projeto BeTheHero
    • configuração do ambiente de desenvolvimento e dicas

  • Aula 02 - 24/03

    • inicio do projeto backend - Node
    • configuração do servidors utilizando express
    • configuração do banco de dados sqlite com knex
    • configuração de rotas de requisição Http - Requests
    • configuração de migrations e controllers
    • testes de requisições através do Insomnia.REST
    • adição da biblioteca cors no backend possibilitando acesso via frontend

  • Aula 03 - 25/03

    • inicio do projeto frontend - React
    • criação do projeto com yarn create-react-app
    • configuração de rotas de acesso com react-router-dom
    • criação das pages Logon e Register Components
    • adição da biblioteca axios e configuração do services/api.js para requisições ao backend

  • Aula 04 - 26/03

    • inicio do projeto mobile - React Native
    • adição global da expo-cli com yarn global add expo-cli
    • criação do projeto com expo init mobile, cd mobile e expo start
    • configuração de rotas de acesso com react-navigation
    • criação das páginas Incidents e Detail Components
    • criação do Scroll Infinito Flatlist
    • adição da biblioteca axios e configuração do services/api.js

  • Aula 05 - 27/03

    • inclusão de Validação celebrate backend
    • inclusão de Testes jest e supertest backend
    • bate-papo sobre Deploy, Padrões de Código eslint e prettier
    • bate-papo sobre Styled Components e Autenticação jwt
    • finalização do projeto e bate-papo
FEATURES - EXTRAS

  • feature 01

    • adição e configuração das bibliotecas eslint, prettier, sucrase e dotenv no backend possibilitando uma melhora produtividade.

  • feature 02

    • adição e configuração da biblioteca styled-components no frontend permitindo estilização perfeita e sem quebras nos componentes.

  • feature 03

    • adição e configuração do tema dark utilizando ThemeProvider do styled-components no frontend.

  • feature 04

    • disponibilização da api(backend) no heroku e do web(frontend) no github.

  • feature 05

    • Dark Theme no mobile com auteração automatica definida pela configuração do dispositivo.

  • feature 06

    • disponibilização da mobile(mobile) no exp.host.

PROJETO FINALIZADO | 29/03/2020

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

License

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

Criado com ♥️ por William 👋