fit track

Vía de ajuste

Fit-Track es una aplicación de seguimiento de registro de ejercicios construida utilizando la pila MERN (MongoDB, Express, React+Vite, Node.js). Esta documentación lo guiará a través del proceso de contribuir a este proyecto.

Tabla de contenido

• Instalación
  • Interfaz
  • Backend
• Que contribuye
  • Bifurcando el repositorio
  • Clonación del repositorio
  • Creando una rama
  • Haciendo cambios
  • Cometer cambios
  • Presionando cambios
  • Creación de una solicitud de extracción
• Licencia

Instalación

Interfaz

1. Navegue al directorio frontend :

    cd frontend

2. Instale las dependencias:

   npm install

3. Inicie el servidor de desarrollo:

   npm run dev

Backend

1. Navegue al directorio backend :

    cd backend

2. Instale las dependencias:

   npm install

3. Configuración MongoDB Atlas:

   1. Vaya a MongoDB Atlas y cree una cuenta si aún no tiene una.
   2. Cree un nuevo clúster siguiendo las indicaciones. Tutorial de creación de clúster de Mongo Atlas
   3. Una vez que se cree el clúster, vaya a la sección de acceso a la base de datos y cree un usuario con los privilegios necesarios.
   4. Vaya al acceso a la red y permita su dirección IP (o permita el acceso desde cualquier lugar si se prueba localmente).
   5. En la sección Clusters , haga clic en Conectar , luego elija Conectar su aplicación . Verás una cadena de conexión que se ve así:

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

   6. Reemplace <username> y <password> con su nombre de usuario y contraseña de MongoDB Atlas real. Copie la cadena de conexión completa.

4. Agregue MongoDB Atlas_uri al archivo .env :

   • Cree un archivo .env en el directorio backend .
   • Agregue la siguiente línea al archivo .env , reemplazando <your-mongodb-connection-string> con la cadena de conexión que copió de MongoDB Atlas:

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

5. Inicie el servidor:

   node server.js

   o si nodemon está instalado para actualizaciones en vivo del backend:

   nodemon server.js

Estructura de proyectos

Interfaz

El directorio frontend contiene la aplicación React.

• public : contiene los activos públicos de la solicitud.
• src : contiene el código fuente de la aplicación.
  • components : componentes de UI reutilizables.
    • Home : componentes de la página de inicio
      • Exercise : componente de fila de ejercicio para mostrar duración, estado, daycheck
      • ExercisesList : para mostrar la lista de ejercicios realizados por el usuario
      • HeatMap : alimentado por apexcharts.js para mostrar la rutina de ejercicio del usuario
      • Quotes : de API Ninjas y muestre las citas al azar para motivar al usuario
      • TotalDays : para mostrar el número de días que el usuario ejerció
      • UserExperience : para mostrar la experiencia del usuario con experiencia gamificada
      • UserRoutine : para mostrar la rutina semanal del usuario como una racha
    • HomePage : Mostrar y representar la página de inicio
    • Login : Mostrar una página de inicio de sesión
    • SignUp : Mostrar una página de usuario de registro y edición
    • navbar : componente de Navbar
• App.jsx : el componente principal que establece rutas.
• main.jsx : el punto de entrada de la aplicación React.

Backend

El directorio backend contiene el servidor Node.js y la aplicación Express.

• models : contiene los esquemas de mangosta.
  • exercise.model Modelo: esquema de ejercicio
  • user.model : esquema de usuario
• routes : contiene las rutas API.
  • exercises : rutas API de backend para ejercicios
  • user : rutas API de backend para usuarios
• server.js : el punto de entrada de la aplicación del servidor.

Que contribuye

¡Agradecemos las contribuciones! Para contribuir a Fit-Track, siga estos pasos:

Bifurcando el repositorio

1. Bifurca el repositorio haciendo clic en el botón "Bifurca" en la parte superior derecha de la página del repositorio en GitHub.

Clonación del repositorio

2. Clone su repositorio bifurcado a su máquina local:

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

3. Navegue al directorio del proyecto:

    cd Fit-Track

Creando una rama

4. Cree una nueva rama para su función o corrección de errores (cree una rama de acuerdo con el problema trabajando):

   git switch -c your-branch-name

Haciendo cambios

5. Realice sus cambios en la base de código. Puede editar los archivos utilizando su editor de código preferido.

Cometer cambios

6. Agregue los cambios al área de puesta en escena:

   git add .

7. Confirme los cambios con un mensaje descriptivo:

   git commit -m " Description of your changes "

Presionando cambios

8. Empuje los cambios a su repositorio bifurcado:

   git push origin your-branch-name

Creación de una solicitud de extracción

9. Cree una solicitud de extracción de su repositorio bifurcado al repositorio principal. Vaya a la pestaña "Solicitud de solicitud" en el repositorio principal y haga clic en "nueva solicitud de extracción". Siga las instrucciones para crear su solicitud de extracción.

¡Este es solo el comienzo! Espero hacer contribuciones más significativas y colaborar con esta increíble comunidad. ¡Construyamos algo grandioso y hagamos que Fit-Track sea lo mejor que pueda ser! ❤️?

Licencia

Este proyecto tiene licencia bajo la licencia MIT; consulte el archivo de licencia para obtener más detalles.