Вклад в проект

Содержание

• Локальная работа
• Работа в Gitpod
• Структура директорий

Вы впервые участвуете в проекте с открытым исходным кодом? Эти рекомендации от GitHub могут вам помочь!

Локальная работа

1. Создайте форк этого репозитория.

2. Клонируйте свой форк на компьютер.

   git clone https://github.com/<your-username>/algorithm-visualizer.git    

3. Решите, будете ли вы запускать server на своём компьютере или использовать удалённый сервер.

   • Если вы решите запустить сервер локально, следуйте инструкциям здесь.

   • Если вы выберете удалённый сервер, временно (то есть не фиксируйте это изменение) измените package.json следующим образом:

     - "proxy": "http://localhost:8080",
     + "proxy": "https://algorithm-visualizer.org",

4. Установите зависимости и запустите веб-приложение.

   cd algorithm-visualizer
   
   npm install
   
   npm start

5. Откройте http://localhost:3000/ в браузере.

Работа в Gitpod

Также можно запустить algorithm-visualizer в Gitpod, бесплатной онлайн-среде разработки для GitHub.

Структура директорий

• branding/ содержит файлы изображений.
• public/ содержит статические файлы для обслуживания.
• src/ содержит исходный код.
  • apis/ определяет исходящие запросы API.
  • common/ содержит часто используемые файлы.
  • components/ содержит компоненты пользовательского интерфейса.
  • core/ обрабатывает визуализацию.
    • layouts/ трассировщики макетов.
    • renderers/ визуализирует данные визуализации.
    • tracers/ интерпретирует команды визуализации в данные визуализации.
  • files/ содержит файлы Markdown или скелеты для отображения в редакторе кода.
  • reducers/ содержит редукторы Redux.