CyberDAS Frontend

Сайт общежития ДАС МГУ, работающий на базе CyberDAS API
Сторибук »

Сообщить об ошибке · Предложить улучшение

Содержание

1. О проекте
2. Приступаем к работе
   • Необходимое ПО
   • Установка
   • Развертывание
3. Дорожная карта
4. Содействие
5. Лицензия
6. Контакты
7. Благодарности

---

О проекте

Вы когда-нибудь стояли в очереди на заселение по несколько часов? Жили пару дней без света в коридоре, потому что не хотелось подниматься к коменданту? Тогда вам знакомо, как неприветлива бывает бюрократия.

Этот проект призван упростить жизнь студентов в общежитии, избавив от их бюрократических рутин и дав им новые, цифровые, возможности.

Мы хотим дать студентам возможность:

• Оставлять заявки на вызов технических служб не выходя из комнаты
• Дистанционно записываться на заселение и не тратить свою жизнь в очереди
• Составлять и отправлять заявления в администрацию без особых усилий
• Делиться ненужными вещами без пабликов-барахолок в ВК
• И многое другое...

Проект создается для общежития ДАС МГУ, работает на базе API.

Если ты тоже хочешь помочь и умеешь в дизайн или код, то пиши нам!

Приступаем к работе

Следуй этим шагам, чтобы локально запустить текующую версию проекта.

Необходимое ПО

• Node.js (>=12, оптимально 14)

Установка

1. Скопируйте репозиторий

   git clone https://github.com/CyberDAS-Dev/Frontend.git

2. Установите зависимости проекта.

   npm i

3. Запустите локальный сервер для разработки, приложение будет доступно по адресу http://localhost:3000

   npm run dev

Скрипты

1. Модульное тестирование компонентов запускается с помощью Jest и использует библиотеку react-testing-library. Для запуска тестов выполните:

   npm test

2. Проверка JS кода работает на базе eslint, совмещенным с инструментом форматирования prettier, использование данных инструментов позволяет содержать код проекта в однородном виде, также исключая часть глупых ошибок.

   1. Для проверки с помощью терминала запустите:

      npm run lint:code

   2. Для автоматического форматирования и исправления ошибок выполните:

      npm run format:code

3. Проверка стилевых файлов работает с помощью stylelint, совмещен вместе с prettier для форматирования.

   1. Для проверки с помощью терминала запустите:

      npm run lint:style

   2. Для автоматического форматирования и исправления ошибок выполните:

      npm run format:style

Развертывание

1. Запустите сборку оптимизированной версии приложения, после которой по умолчанию сервер будет запущен на 3000 порту http://localhost:3000

   npm run build
   npm start

Настройка среды

1. Для корректной работы линтинга и форматирования, в IDE (рекомендую использовать VS Code) требуется установить расширения eslint, stylelint, prettier. Для автоматического форматирования кода при сохранении файла добавьте данные строки в настройки (settings.json) VSCode:

   "files.autoSave": "onFocusChange",
   "editor.formatOnSave": true,
   "eslint.format.enable": true,
   "[scss]": {
       "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
   "[javascriptreact]": {
       "editor.defaultFormatter": "dbaeumer.vscode-eslint"
   },
   "[javascript]": {
       "editor.defaultFormatter": "dbaeumer.vscode-eslint"
   }

Дорожная карта

Смотрите milestones для информации о планируемых релизах и долгосрочных планов.

Содействие

Совместная разработка это то, что делает опен-сорс сообщество таким удивительным местом для обучения и творчества. Мы ценим любой ваш вклад в проект.

1. Сделайте копию (Fork) проекта
2. Создайте свою ветку для работы (git checkout -b feature/AmazingFeature)
3. Сохраните изменения (git commit -m 'Add some AmazingFeature')
4. Отправьте их в удаленную ветку (git push origin feature/AmazingFeature)
5. Создайте Pull Request

Лицензия

Распространяется под лицензией MIT. Смотрите LICENSE для дополнительной информации.

Контакты

marcusymka@gmail.com
telegram

Ссылка на проект: https://github.com/CyberDAS-Dev/API

Благодарности

• Александр Букреев, оригинальный создатель проекта
• Студенческий комитет ДАС МГУ
• Best-README-Template