Rocketseat Experience 2023 - Mobile App

Repositório do app construído pela comunidade para o maior evento de programação do Brasil! :brazil:

Executando o projeto

Abaixo seguem as instruções para você executar o projeto na sua máquina.

Comece clonando o repositório e instalando suas dependências:

git clone https://github.com/diego3g/rsxp-2023
cd rsxp-2023
npm install

Back-end

O back-end desse projeto é construído em Node.js, mais especificamente sua versão LTS.

Você pode instalar o Node.js seguindo esse guia.

Além do Node.js, utilizamos o banco de dados PostgreSQL e recomendamos o uso do Docker para executar o banco em sua máquina.

Você pode instalar o Docker seguindo esse guia.

Nesse projeto, usamos o serviço de autenticação Clerk, e você precisará configurá-lo para rodar o projeto em sua máquina.

Você pode configurar o Clerk seguindo esse guia.

Após instalar o Node.js e o Docker, vamos acessar a pasta do projeto back-end, subir o serviço do banco de dados, configurar nossas variáveis ambiente e, então, subir o servidor HTTP.

cd apps/server

# Copiar o arquivo com os dados de conexão e demais variáveis ambiente
cp .env.example .env

# Subir o serviço do PostgreSQL via docker (caso não tenha instalado o PostgreSQL em seu computador)
docker-compose up -d

# Rodar as migrations do prisma
npx prisma migrate dev

# Subir o servidor HTTP
npm run start:dev

Mobile

Para executar o app mobile do RS/XP utilizamos o Expo, uma ferramenta incrível da comunidade React Native. Além do Expo, é necessário que você utilize algum emulador local ou um dispositivo físico pra visualizar a aplicação.

Você pode instalar o Expo e os emuladores seguindo esse guia.

Após configurar o ambiente mobile, você pode abrir o emulador e executar o projeto de acordo com a plataforma que estiver utilizando:

# Caso esteja usando Android
npm run android

# Caso esteja usando iOS
npm run ios

# Caso esteja usando um dispositivo físico
npm start

Links rápidos ↗

• Documentação Principal | Notion 📖
• Layout | Figma 🎨

Tech Stack 💜

A stack foi escolhida pela comunidade durante a live de kick-off.

📱 Mobile:

• Expo
• TypeScript
• NativeWind (Tailwind para o React Native)

🏧 Server:

• NestJS (REST)
• Prisma
• PostgreSQL Neon Database
• TypeScript
• Sympla API

Funcionalidades 🚀

Até o momento, levando em consideração o prazo de 2 semanas (Due: 11/04/2023), listamos algumas funcionalidades básicas que devemos entregar. Caso sobre tempo, podemos trabalhar em funcionalidades secundárias, backlog.

Funcionalidades 1.0 (MVP):

• [ ] Comprar ingresso Redirecionar o usuário para o Sympla para efetuar a compra.

• [ ] Visualizar meu ingresso Uma vez que tenha o código localizador do ingresso emitido pelo Sympla, o usuário poderá conectar seu ingresso à sua conta no app e, dessa forma, terá acesso pelo app.

• [ ] Compartilhar ingresso nas redes sociais Como uma forma de hypar o evento, o usuário poderá gerar uma imagem - thumbnail com sua foto para divulgar nas redes! #VouNaRSXP! 🚀💜

Funcionalidades 2.0:

• [ ] Autenticação

• [ ] Sistema de convites

  • Desconto p/ convidar
  • Brindes p/ quem mais convidar

• [ ] Countdown pro evento

• [ ] Dados gerais do evento

  • Localização
  • Data & Hora

• [ ] FAQ - (Frequently Asked Questions / Perguntas Frequentes)

• [ ] Feed de notícias Criar algo tipo um Twitter interno para evento. Tal aba será dedicada aos palestrantes ou organizadores para enviar avisos para os membros.

• [ ] Lista dos palestrantes

Contribuições 🆘

Estamos muito felizes em ter vocês interessados em contribuir com nosso projeto. Queremos deixar claro que a participação de vocês é muito importante para o sucesso do nosso aplicativo, e valorizamos muito as ideias e contribuições que vocês podem trazer.

Para facilitar a interação entre todos, gostaríamos de lembrar alguns pontos importantes sobre como contribuir com nosso projeto:

Discussões

Utilizem a aba de discussões para compartilhar ideias e sugestões para o projeto. Essa é uma ótima maneira de começar uma discussão sobre algo que possa ser melhorado ou adicionado ao aplicativo.

Issues

Caso encontrem algum problema durante o uso do aplicativo ou queiram sugerir uma nova tarefa, utilizem a aba de issues. Lá, vocês podem postar as suas sugestões e reportar problemas encontrados. É importante lembrar que novas tarefas só devem ser criadas se a comunidade aprovar na aba de discussões.

Pull Requests

Se vocês quiserem contribuir com código, podem fazer um fork do repositório e trabalhar em suas próprias cópias. Quando finalizarem, enviem um pull request para que possamos revisar o código e integrar ao projeto principal.

#Dica 💡: Não tenha medo de fazer um Pull Request, utilize dessa oportunidade para receber críticas construtivas de outras pessoas acerca do seu código e melhore suas habilidades!

Conduta

Para que esse projeto prospere é preciso manter um ambiente saudável e respeitoso, Pedimos que leiam e sigam as nossas regras para garantir que todos possam contribuir em um ambiente agradável e produtivo.

Mais uma vez, queremos agradecer a vocês por estarem dispostos a contribuir com o nosso projeto. Estamos ansiosos para trabalhar com vocês e construir algo incrível juntos!

#JuntosParaOPróximoNível 🚀

Roadmap

• MVP v1.0.0 📅 Meta: 11/04/2023 - Lançar o app com as funcionalidades listadas acima e acordadas durante a live de kick-off.

• Só o tempo dirá... 👀

Contribuidores 😊

Licença 📃

MIT