Слияние кода завершено, страница обновится автоматически
spring-boot-doc — это система управления документами, созданная для удобства использования IT-командами. Предшественником spring-boot-doc является MinDoc, а MinDoc был основан на системе документации SmartWiki. SmartWiki — это система управления документами, разработанная с использованием PHP-фреймворка Laravel. Однако установка PHP-приложений для обычных пользователей может быть сложной задачей, поэтому авторы перешли на использование Go. Но для Java-разработчиков использование Go может вызывать проблемы, которые они не могут решить самостоятельно. Поэтому была создана версия MinDoc на Spring Boot, что позволяет легко устанавливать и использовать её для Java-разработчиков. В настоящее время система имеет ограниченный набор функций, но она постоянно развивается.## Структура проекта
├─src
│ ├─main
│ │ ├─java
│ │ │ └─com
│ │ │ └─itstyle
│ │ │ └─doc
│ │ │ │ Application.java -- основной класс запуска
│ │ │ │
│ │ │ ├─common -- общие пакеты
│ │ │ │ ├─constans
│ │ │ │ │
│ │ │ │ ├─interceptor
│ │ │ │ │
│ │ │ │ └─utils
│ │ │ │
│ │ │ ├─model -- модели данных
│ │ │ │
│ │ │ ├─repository -- доступ к данным
│ │ │ │
│ │ │ └─web -- контроллеры
│ │ │
│ │ ├─resources -- конфигурационные файлы системы
│ │ │ │ application-dev.properties
│ │ │ │ application-prod.properties
│ │ │ │ application-test.properties
│ │ │ │ application.yml
│ │ │ │ kaptcha.xml
│ │ │ │ logback-spring.xml
│ │ │ │
│ │ │ ├─sql -- SQL-скрипты базы данных
│ │ │ │
│ │ │ ├─static -- статические ресурсы
│ │ │ │
│ │ │ ├─templates -- шаблоны представлений
│ │ │ │
│ │ │ └─uploads -- каталог загрузки файлов
│ │ │
│ │ └─webapp
│ │ │ index.jsp
│ │ │
│ │ └─WEB-INF
│ │ web.xml
│ │
```## Установка и использование
Как разработчику AJAV, вам необходим JDK на вашем компьютере, затем вам нужна среда разработки (Eclipse или IntelliJ IDEA) и наконец, вы должны быть знакомы с простым и удобным в использовании фреймворком быстрого развития Spring Boot.
После самостоятельной загрузки проекта настройте базу данных; это приведёт к автоматическому созданию таблиц при выполнении файла `doc.sql` и инициализации суперпользователя `admin` с паролем `111111`. После входа рекомендуется изменить пароль.
## Используемые технологии
- spring-boot 1. 5. 2
- spring-data-jpa 1. 11. 1
- thymeleaf 2. 1. 5
- kaptcha 2. 3. 2
- mysql 5. 6
- editor.md
- bootstrap 3. 2
- vuejs 2. 2. 6
- jQuery библиотека
- Layer модальное окно
- WebUploader загрузка файлов
- NProgress библиотека
- jstree деревья
- Font Awesome шрифты
- Cropper обрезка изображений
- Layer модальное окно
- Highlight подсветка кода
- To-Markdown преобразование HTML в Markdown
- WangEditor редактор富文本编辑器## Основные функции
- Управление проектами, позволяющее редактировать проекты, добавлять участников и т. д.
- Управление документами, позволяющее добавлять и удалять документы.
- Управление комментариями, позволяющее управлять комментариями документов и своими публикациями.
- Управление пользователями, позволяющее добавлять и отключать пользователей, а также изменять личные данные.
- Управление правами доступа, позволяющее реализовывать изменения ролей пользователей.
- Шифрование проектов, позволяющее устанавливать открытый или закрытый статус проекта, где закрытые проекты требуют доступа через токены.
- Настройка сайта, позволяющая активировать анонимный доступ, CAPTCHA и т. д.
- Нестабильные выпуски новых функций.## Скриншоты проекта
## Дружественные советы
- **spring-boot-doc** как проект для начинающих требует знания технологий Spring Boot, Thymeleaf, JPA, VueJS и других. В процессе разработки нельзя гарантировать корректную работу всех функций.
- В проекте используется Lombok, поэтому если вы ещё не установили его, могут возникнуть ошибки. [Советы по использованию Lombok](https://blog.52itstyle.com/archives/1557/) Если вам не требуется использование Lombok, удалите соответствующие аннотации, чтобы сгенерировать методы get/set и конструкторы.- Для использования MinDoc перейдите к руководству по установке: [Рекомендация: система управления документацией для API — MinDoc](https://blog.52itstyle.com/archives/1557/)
Автор: XiaoQi2012Приглашаем вас следить за нами: https://blog.52itstyle.com
Вы можете оставить комментарий после Вход в систему
Неприемлемый контент может быть отображен здесь и не будет показан на странице. Вы можете проверить и изменить его с помощью соответствующей функции редактирования.
Если вы подтверждаете, что содержание не содержит непристойной лексики/перенаправления на рекламу/насилия/вульгарной порнографии/нарушений/пиратства/ложного/незначительного или незаконного контента, связанного с национальными законами и предписаниями, вы можете нажать «Отправить» для подачи апелляции, и мы обработаем ее как можно скорее.
Комментарии ( 0 )