Leve felicidade para o mundo

🎉 Sobre

happy é uma plataforma que ajuda pessoas a encontrarem orfanatos próximos para levar felicidade a milhares de crianças.

Este projeto foi desenvolvido usando Node.js, ReactJS e React Native, durante a 3ª edição da Next Level Week ministrada pela Rocketseat.

🎨 Layout

Os layouts da aplicação estão disponíveis no Figma: Web, Mobile.

🔌 Tecnologias

Front-end

• React
• React Native
• Styled Components
• Typescript
• Expo

Back-end

• Node.js
• Express
• TypeORM
• Typescript

Ambiente de desenvolvimento

• VS Code
• EditorConfig
• ESLint
• Prettier

🤔 Como executar

Para clonar esse repositório pelo terminal, é necessário possuir o Git instalado em sua máquina.

# Clone o repositório
$ git clone https://github.com/Bonizario/happy.git

# Entre na pasta do projeto
$ cd happy

Para instalar as dependências e executar o projeto, é necessário possuir o Node.js instalado em sua máquina, bem como um gerenciador de pacotes: Yarn ou npm.

# Instale as dependências do back-end
$ cd backend && yarn

# Execute as migrations do TypeORM
$ yarn typeorm migration:run

# Execute a api em Node.js
$ yarn dev:server

# Instale as dependências do front-end web
$ cd ../web && yarn

# Execute o front-end em ReactJS
$ yarn start

# Instale as dependências do back-end
$ cd backend && npm install

# Execute as migrations do TypeORM
$ npm run typeorm migration:run

# Execute a api em Node.js
$ npm run dev:server

# Instale as dependências do front-end web
$ cd ../web && npm install

# Execute o front-end em ReactJS
$ npm start

💭 Como contribuir

Caso queira contribuir, seja corrigindo bugs, adicionando comentários ou novas features, você pode seguir o seguinte tutorial:

• Faça um fork desse repositório
• Clone o repositório que você fez o fork em seu computador
• Crie uma branch com a sua feature: git checkout -b minha-alteracao
• Envie suas alterações para a staging area: git add .
• Faça um commit contando o que você fez: git commit -m "feat: minha nova alteracao!"
• Faça um push para a sua branch: git push origin minha-alteracao
• Agora é só abrir uma pull request

Caso tenha alguma dúvida, confira este guia de como contribuir no GitHub :)

📝 License

Esse projeto está sob a licença MIT. Consulte LICENSE para mais informações.

📮 Entre em contato

Linkedin: https://www.linkedin.com/in/gabriel-bonizario/

Desenvolvido por Gabriel Bonizário 👋🏻