fit track

Подходящая трек

Fit-Track-это приложение для отслеживания журнала упражнений, созданное с использованием стека Mern (MongoDB, Express, React+Vite, Node.js). Эта документация поможет вам в процессе участия в этом проекте.

Оглавление

• Установка
  • Внешний интерфейс
  • Бэкэнд
• Внося
  • Подтягивание репозитория
  • Клонирование репозитория
  • Создание филиала
  • Внесение изменений
  • Совершать изменения
  • Выдвигая изменения
  • Создание запроса на притяжение
• Лицензия

Установка

Внешний интерфейс

1. Перейдите к каталогу frontend :

    cd frontend

2. Установите зависимости:

   npm install

3. Запустите сервер разработки:

   npm run dev

Бэкэнд

1. Перейдите в backend каталог:

    cd backend

2. Установите зависимости:

   npm install

3. Настройка Mongodb Atlas:

   1. Зайдите в Mongodb Atlas и создайте учетную запись, если у вас его еще нет.
   2. Создайте новый кластер, следуя подсказкам. Учебное пособие по созданию кластера Mongo Atlas
   3. После создания кластера перейдите в раздел доступа к базе данных и создайте пользователя с необходимыми привилегиями.
   4. Перейдите в сеть доступа и разрешите свой IP -адрес (или разрешайте доступ из любого места, если он тестирует локально).
   5. В разделе «Кластеры» нажмите Connect , затем выберите подключить приложение . Вы увидите строку подключения, которая выглядит так:

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

   6. Замените <username> и <password> на свое фактическое имя пользователя и пароль Mongodb Atlas. Скопируйте всю строку подключения.

4. Добавить mongodb atlas_uri в файл .env :

   • Создайте файл .env в backend .
   • Добавьте следующую строку в файл .env , заменив <your-mongodb-connection-string> на строку подключения, которую вы скопировали из Mongodb Atlas:

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

5. Запустить сервер:

   node server.js

   или если nodemon установлен для живых обновлений Backend:

   nodemon server.js

Структура проекта

Внешний интерфейс

Справочник frontend содержит приложение React.

• public : содержит общественные активы заявки.
• src : содержит исходный код приложения.
  • components : многоразовые компоненты пользовательского интерфейса.
    • Home : Компоненты домашней страницы
      • Exercise : Компонент строки упражнений, чтобы отобразить продолжительность, статус, дневной конец
      • ExercisesList : чтобы отобразить список упражнений, выполненных пользователем
      • HeatMap : питание от ApexCharts.js для отображения упражнений пользователя
      • Quotes : из API Ninjas и отображайте цитаты случайным образом, чтобы мотивировать пользователя
      • TotalDays : чтобы отобразить количество дней, которые пользователь осуществлял
      • UserExperience : чтобы отобразить пользовательский опыт с игровым опытом
      • UserRoutine : чтобы отобразить еженедельную рутину пользователя, как серия
    • HomePage : отображение и отображение домашней страницы
    • Login : отображение страницы входа в систему
    • SignUp : отображение страницы регистрации и редактирования пользователя
    • navbar : компонент NAVBAR
• App.jsx : основной компонент, который устанавливает маршруты.
• main.jsx : точка входа приложения React.

Бэкэнд

backend каталог содержит сервер Node.js и Express.

• models : содержит схемы мангуза.
  • exercise.model : схема упражнений
  • user.model : схема пользователя
• routes : содержит маршруты API.
  • exercises : бэкэнд -маршруты API для упражнений
  • user : Backend API -маршруты для пользователей
• server.js : точка входа приложения сервера.

Внося

Мы приветствуем вклад! Чтобы внести свой вклад в Fit-Track, следуйте этим шагам:

Подтягивание репозитория

1. Вилка репозитория, нажав кнопку «Вилка» в правом верхнем правом правом правом репозитории на GitHub.

Клонирование репозитория

2. Клонировать свой раздвоенный репозиторий на местную машину:

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

3. Перейдите к каталогу проекта:

    cd Fit-Track

Создание филиала

4. Создайте новую филиал для вашей функции или исправления ошибок (создайте филиал в соответствии с проблемой, над которой работает):

   git switch -c your-branch-name

Внесение изменений

5. Внесите свои изменения в кодовую базу. Вы можете отредактировать файлы, используя ваш предпочтительный редактор кода.

Совершать изменения

6. Добавьте изменения в зону постановки:

   git add .

7. Совершить изменения с описательным сообщением:

   git commit -m " Description of your changes "

Выдвигая изменения

8. Нажмите изменения в ваш раздвоенный репозиторий:

   git push origin your-branch-name

Создание запроса на притяжение

9. Создайте запрос на притяжение из вашего раздвоенного хранилища в основной репозиторий. Перейдите на вкладку «Позвольт запросов» в основном репозитории и нажмите «Новый запрос на вытягивание». Следуйте инструкциям, чтобы создать ваш запрос на привлечение.

Это только начало! Я с нетерпением жду возможности внести более значимый вклад и сотрудничать с этим удивительным сообществом. Давайте построим что-то отличное вместе и сделаем Fit-Track как можно лучше! ❤?

Лицензия

Этот проект лицензирован по лицензии MIT - для получения подробной информации см. Файл лицензии.