sticky memo

Липкий мемо

Sticky-Memo-это приложение из липких нот, созданное с использованием React.js и VITE. Эта документация поможет вам в процессе участия в этом проекте.

Оглавление

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

Установка

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

1. Вилка репозитория , нажав кнопку «Вилка» в правом верхнем правом правом правом репозитории на GitHub.
2. Клонировать свой раздвоенный репозиторий на местную машину:

   git clone https://github.com/your-username/Sticky-Memo.git

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

    cd Sticky-Memo

Установка фронта

После клонирования хранилища:

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

   npm install

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

   npm run dev

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

Проект

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

• public : содержит общественные активы заявки.
• src : содержит исходный код приложения.
  • components : многоразовые компоненты пользовательского интерфейса.
    • list of components : список всех компонентов
  • pages : страницы
    • list of pages : список всех страниц
  • styles : стиль
    • list of styles : Список всех таблиц стилей
  • utils
    • list of utils : Список всех утилит
• App.jsx : основной компонент, который устанавливает маршруты.
• main.jsx : точка входа приложения React.

Внося

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

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

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

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

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

   git clone https://github.com/your-username/Sticky-Memo.git

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

    cd Sticky-Memo

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

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. Создайте запрос на притяжение из вашего раздвоенного хранилища в основной репозиторий. Перейдите на вкладку «Позвольт запросов» в основном репозитории и нажмите «Новый запрос на вытягивание». Следуйте инструкциям, чтобы создать ваш запрос на привлечение.

Участники

Мы ценим вклад следующих людей: участники

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

Лицензия

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