Skip to content

Latest commit

 

History

History
176 lines (130 loc) · 6.61 KB

README.md

File metadata and controls

176 lines (130 loc) · 6.61 KB
Raw
NLW Copa


Sobre   |   Features   |   Tecnologias e ferramentas utilizadas   |   Layout   |   Instalação e execução   |   Como contribuir   |   Contato   |   Licença

📃 Sobre

Landing page NLW Copa

NLW Copa é o projeto desenvolvido durante a trilha Ignite da Next Level Week, um evento online produzido pela Rocketseat.

O projeto consiste em uma aplicação com a temática da copa, que permitirá os usuários criarem seus próprios bolões da copa e compartilhá-los com seus amigos.

✨ Features

Back-end

  • Criação de um bolão
  • Contagem de bolões, usuários e palpites cadastrados
  • Schema validation utilizando o Zod
  • Diagrama ERD (entidade-relacionamento):

Diagrama ERD

Front-end (Web)

  • Criação de um bolão
  • Exibição da quantidade de usuários, bolões, e palpites criados

Mobile

🚧 Em desenvolvimento 🚧

🚀 Tecnologias e ferramentas utilizadas

Back-end NodeJs, Typescript, Prisma, Fastify, Zod, SQLite
Front-end (web) React, TypeScript, NextJS, TailwindCSS, Axios
Mobile React Native, Expo, Native Base

📟 Layout

O layout das telas da aplicação NLW Copa foi desenvolvido pela equipe da Rocketseat através da ferramenta Figma. Você pode acessar o layout através deste link: NLW Copa.

🔧 Instalação e execução

Para baixar o código-fonte do projeto em sua máquina, primeiramente terá que ter instalado o Git.

Com o Git instalado, em seu terminal execute o seguinte comando:

git clone https://github.com/mathrb22/nlw-copa-ignite.git

Para instalar as dependências e executar o projeto terá que ter instalado em sua máquina o Node.js, que vem acompanhado do NPM. Com ele instalado:

Navegue para as subpastas separadas para cada projeto (web/server/mobile) e rode o comando a seguir:

npm install

Executar o projeto web:

npm run dev

Executar o servidor node:

npm run dev

Executar o projeto mobile:

npm start

💡 Como contribuir

  • Faça um fork desse repositório;
  • Crie um branch para a sua feature: git checkout -b minha-feature;
  • Faça um commit com suas alterações: git commit -m 'feat: Minha nova feature';
  • Faça um push para o seu branch: git push origin minha-feature;
  • Faça um pull request com sua feature;

Pull requests são sempre bem-vindos. Em caso de dúvidas ou sugestões, crie uma issue ou entre em contato comigo.

📲 Contato

Entre em contato comigo por e-mail ou pelo meu LinkedIn:

Gmail LinkedIn

📝 Licença

GitHub License

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

©2022 - Matheus Ribeiro