Como começar
Começando
Esse é um tutorial rápido para que você possa começar a sua jornada no desenvolvimento do backend da aplicação Multi Fit.
O que é o Multi Fit?
Multi Fit é um projeto contratado pela Multi, em que iremos desenvolver um produto. Este produto é um aplicativo mobile "FITNESS" que vai captar dados de um Smart Watch e enviar para um servidor, onde esses dados serão processados e analisados. Os smart watches foram entregues pela Multi e o aplicativo mobile será desenvolvido por nós, a SDK do smart watch também foi fornecida, para que possamos conectar o app ao relógio e ler os dados.
Do que você irá precisar?
Node.js versão 14.0 ou above:
- Ao instalar o Node.js, o npm também será instalado automaticamente.
Yarn versão 1.22 ou superior:
- O Yarn é o gerenciador de pacotes que iremos usar no projeto.
- O Docker é uma ferramenta que permite a criação de containers, que são ambientes isolados que possuem suas próprias dependências e configurações. Nesse projeto iremos usar o Docker para criar um container com o banco de dados que iremos usar.
Facilita a criação, execução e orquestração de containers Docker em ambiente de desenvolvimento.
- Certifique-se de ter acesso ao repositório do projeto, caso não tenha, peça acesso para o seu líder técnico.
Clonando o repositório
Para começar, você deve clonar o repositório do projeto. Para isso, abra o terminal e execute o seguinte comando:
git clone git@github.com:lubysoftware/multi-fit-backend.git
Você pode digitar esse comando no terminal de sua preferência, como o terminal do VSCode, por exemplo. Entre na pasta clonada:
cd multi-fit-backend
Atualize as variáveis de ambiente
O projeto usa variáveis de ambiente para configurar algumas coisas, como o banco de dados, por exemplo. Para que o projeto funcione corretamente, você deve criar um arquivo .env na raiz do projeto, com as mesmas variáveis que estão no arquivo .env.example. Você pode copiar o conteúdo do arquivo .env.example e colar no arquivo .env e então preencher os valores das variáveis.
Caso o projeto já tenha começado, você pode pedir a alguém da sua equipe para te passar o conteúdo do arquivo .env.
Inicie o servidor
Para iniciar o servidor, execute o seguinte comando:
docker-compose up
Caso você queira parar o servidor, pressione Ctrl + C no terminal. E caso deseje remover os containers, execute o seguinte comando:
docker-compose down --rmi all
Em alguns casos é necessário iniciar o servidor com o comando sudo docker-compose up. Isto vai depender de como estão configuradas as permissões do docker no seu sistema Unix