Plataforma de gerenciamento para academias

Sobre o projeto | Tecnologias | Guia de instalação e execução | Licença

💅 Preview

Projeto em andamento

💻 Sobre o projeto

O Gympoint é um gerenciador para academias. O backend é uma REST Api onde fornece todas as regras de negócio e persistência para as aplicações web.

A versão web é composta pelo gerenciamento de alunos, matrículas, planos e pedidos de ajuda dos alunos. Já a versão mobile foi pensada para os alunos realizerem checkIn e solicitarem ajuda para a academia.

Este projeto foi proposto ser desenvolvido com React.js, porém decidi fazer uma versão em Angular para entendimento de diferenças de ambos ecosistemas.

🚀 Tecnologias

• Angular
• Node.js
• React Native

📚 Guia de instalação e execução

Pré-requisitos

• Git
• Node.js
• Yarn
• Mailtrap
• PostgreSQL
• Emulador Mobile ou dispositivo fisíco

Acesse aqui a documentação da Rocketseat com o passo-a-passo e erros mais comuns para montar seu ambiente Mobile.

Como executar

Antes de executar estes passos, você precisa ter um database no PostgreSQL ou em uma imagem do Docker.

Server

• Clone o repositório git clone https://github.com/nathaliacristina20/gympoint.git
• Execute yarn para instalar as dependências de todos pacotes
• Vá até o diretório cd packages/server
• Copie o arquivo .env.example executando cp .env.example .env para linux ou mac e copy .env.example .env para windows
• Abra o arquivo .env e preencha com suas variáveis de ambiente
• Execute yarn migrations para rodar as migrations e yarn seeds para executar os seeds da aplicação
• Execute yarn dev para rodar o servidor

Você pode realizar requisições REST através do Insomnia

Web

• Vá para o diretório da versão web e rode yarn start para executar a aplicação
• Sua aplicação está rodando, vá até http://localhost:4200 no seu browser
• Utilize as informações abaixo para realizar o login:

user: admin@gympoint.com
senha: 123456

Mobile

Com um emulador

• Vá até o diretório do mobile
• Copie o arquivo .env.example executando cp .env.example .env para linux ou mac e copy .env.example .env para windows
• Abra o arquivo .env e preencha com suas variáveis de ambiente
• Abra um dispositivo no seu emulador
• Execute yarn android ou yarn ios de acordo o sistema operacional que você deseja rodar
• Execute yarn start

Pronto! Feche e abra novamente o aplicativo.

Com um dispositivo físico

Certifique-se que seu dispositivo esteja com o modo desenvolver ativado.

• Vá até o diretório do mobile
• Copie o arquivo .env.example executando cp .env.example .env para linux ou mac e copy .env.example .env para windows
• Abra o arquivo .env e preencha com suas variáveis de ambiente
• Conecte seu dispositivo físico em um cabo USB
• Execute yarn android ou yarn ios de acordo o sistema operacional que você deseja rodar
• Execute yarn start

Pronto! Feche e abra novamente o aplicativo.

📃 Licença

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

---

by Nathalia Cristina 👋 Get in touch!