fit track

Fit-track

O FIT-Track é um aplicativo de rastreamento de log de exercícios construído usando a pilha Mern (MongoDB, Express, React+Vite, Node.js). Esta documentação o guiará através do processo de contribuição para este projeto.

Índice

• Instalação
  • Front-end
  • Back -end
• Contribuindo
  • Batendo o repositório
  • Clonando o repositório
  • Criando um ramo
  • Fazendo alterações
  • Cometendo mudanças
  • Empurrando mudanças
  • Criando um pedido de tração
• Licença

Instalação

Front-end

1. Navegue até o diretório frontend :

    cd frontend

2. Instale as dependências:

   npm install

3. Inicie o servidor de desenvolvimento:

   npm run dev

Back -end

1. Navegue até o diretório backend :

    cd backend

2. Instale as dependências:

   npm install

3. Configure o MongoDB Atlas:

   1. Vá para o MongoDB Atlas e crie uma conta se ainda não tiver uma.
   2. Crie um novo cluster seguindo os prompts. Tutorial de criação de cluster do Atlas Mongo
   3. Depois que o cluster for criado, vá para a seção Acesso ao banco de dados e crie um usuário com os privilégios necessários.
   4. Vá para o acesso à rede e permita seu endereço IP (ou permita o acesso de qualquer lugar se testar localmente).
   5. Na seção Clusters , clique em Conectar e escolha Conectar seu aplicativo . Você verá uma string de conexão que se parece com o seguinte:

       mongodb+srv://<username>:<password>@cluster0.mongodb.net/?retryWrites=true&w=majority
      

   6. Substitua <username> e <password> pelo seu nome de usuário e senha do MongoDB ATLAS. Copie toda a string de conexão.

4. Adicione MongoDB Atlas_URI ao arquivo .env :

   • Crie um arquivo .env no diretório backend .
   • Adicione a seguinte linha ao arquivo .env , substituindo <your-mongodb-connection-string> -string> com a string de conexão que você copiou do MongoDB Atlas:

     ATLAS_URI=mongodb+srv:// < username > : < password > @cluster0.mongodb.net/fit-track ? retryWrites=true & w=majority

5. Inicie o servidor:

   node server.js

   ou se nodemon estiver instalado para atualizações ao vivo do back -end:

   nodemon server.js

Estrutura do projeto

Front-end

O diretório frontend contém o aplicativo React.

• public : contém os ativos públicos do aplicativo.
• src : contém o código -fonte do aplicativo.
  • components : componentes da interface do usuário reutilizáveis.
    • Home : componentes da página inicial
      • Exercise : Exercício do componente da linha para exibir duração, status, diqueckeca
      • ExercisesList : para exibir a lista de exercícios feitos pelo usuário
      • HeatMap : alimentado por ApexCharts.js para exibir a rotina de exercícios do usuário
      • Quotes : da API Ninjas e exibir as citações aleatoriamente para motivar o usuário
      • TotalDays : Para exibir o número de dias, o usuário exerceu
      • UserExperience : para exibir a experiência do usuário com experiência gamificada
      • UserRoutine : para exibir a rotina semanal do usuário como uma sequência
    • HomePage : exibindo e renderizando a página inicial
    • Login : exibindo uma página de login
    • SignUp : exibindo uma página de inscrição e edição do usuário
    • navbar : componente de navbar
• App.jsx : o componente principal que configura rotas.
• main.jsx : o ponto de entrada do aplicativo React.

Back -end

O diretório backend contém o servidor Node.js e o aplicativo Express.

• models : contém os esquemas de mangusto.
  • exercise.model : Esquema de exercícios
  • user.model : Esquema do usuário
• routes : contém as rotas da API.
  • exercises : rotas de API de back -end para exercícios
  • user : rotas de API de back -end para usuários
• server.js : o ponto de entrada do aplicativo do servidor.

Contribuindo

Congratulamo -nos com contribuições! Para contribuir para o Fit-Track, siga estas etapas:

Batendo o repositório

1. Gire o repositório clicando no botão "garfo" no canto superior direito da página do repositório no github.

Clonando o repositório

2. Clone seu repositório bifurcado à sua máquina local:

   git clone https://github.com/your-username/Fit-Track.git

3. Navegue até o diretório do projeto:

    cd Fit-Track

Criando um ramo

4. Crie uma nova filial para o seu recurso ou correção de bug (crie uma filial de acordo com a questão que trabalha):

   git switch -c your-branch-name

Fazendo alterações

5. Faça suas alterações na base de código. Você pode editar os arquivos usando seu editor de código preferido.

Cometendo mudanças

6. Adicione as alterações à área de estadiamento:

   git add .

7. Compreenda as mudanças com uma mensagem descritiva:

   git commit -m " Description of your changes "

Empurrando mudanças

8. Empurre as mudanças no seu repositório bifurcado:

   git push origin your-branch-name

Criando um pedido de tração

9. Crie uma solicitação de tração do seu repositório bifurcado para o repositório principal. Vá para a guia "Pull Solictações" no repositório principal e clique em "Nova solicitação de puxar". Siga as instruções para criar sua solicitação de tração.

Este é apenas o começo! Estou ansioso para fazer contribuições mais significativas e colaborar com esta comunidade incrível. Vamos construir algo ótimo juntos e tornar o Fit-Track o melhor que pode ser! ❤️?

Licença

Este projeto está licenciado sob a licença do MIT - consulte o arquivo de licença para obter detalhes.