mirivlad
d97e4d4944
|
||
|---|---|---|
| admin | ||
| assets | ||
| config | ||
| includes | ||
| models | ||
| uploads | ||
| vendor | ||
| views | ||
| README.md | ||
| author.php | ||
| book_delete.php | ||
| book_delete_all.php | ||
| book_edit.php | ||
| book_regenerate_token.php | ||
| books.php | ||
| chapter_delete.php | ||
| chapter_edit.php | ||
| chapters.php | ||
| composer.json | ||
| composer.lock | ||
| dashboard.php | ||
| export_book.php | ||
| index.php | ||
| install.php | ||
| login.php | ||
| logout.php | ||
| preview.php | ||
| profile.php | ||
| register.php | ||
| series.php | ||
| series_delete.php | ||
| series_edit.php | ||
| view_book.php | ||
| view_series.php | ||
README.md
Web Writer
Лицензия: AGPLv3
Web Writer — веб-приложение для написания, хранения и публикации книг и серий книг. Поддерживает Markdown с расширением для диалогов, автосохранение текста, экспорт и управление пользователями.
🚀 Возможности
- Книги и серии: создавайте серии и добавляйте книги с главами.
- Редактор книг: Markdown, автосохранение текста, интерактивное содержание.
- Предпросмотр книг:
- Автор: видит все черновики и опубликованные главы.
- Публичный доступ: только опубликованные главы по ссылке с
shared_token.
- Обложки и аватары: добавляйте изображения к книгам и профилям.
- Экспорт: PDF, DOCX, HTML, TXT.
- Администрирование пользователей:
- Управление аккаунтами, активация/деактивация.
- При удалении пользователя удаляются все его книги.
- Публичные ссылки: делитесь
shared_tokenдля просмотра опубликованных глав.
⚙️ Требования
- PHP: 8.0 и выше
- MySQL с InnoDB и внешними ключами
- PHP расширения:
mbstring,json,PDO - Веб-сервер с правами на запись в папки
config/иuploads/
Все библиотеки уже включены в
vendor/. Composer не нужен.
🛠 Установка
-
Скопируйте файлы на веб-сервер.
-
Проверьте доступность папок
config/иuploads/для записи. -
Перейдите в браузере на
install.phpи следуйте шагам:Шаг 1: Настройки базы данных
- Хост БД
- Имя базы данных
- Пользователь и пароль
Шаг 2: Создание администратора
- Имя пользователя
- Пароль
- Email (по желанию)
- Отображаемое имя (по желанию)
-
После успешной установки файл
config/config.phpбудет сгенерирован автоматически. -
Перейдите на главную страницу приложения (
index.php) и войдите под админом. -
Не забудьте удалить или переместить файл install.php!!!
📝 Конфигурация
Файл config/config.php содержит:
- Подключение к базе данных:
DB_HOST,DB_USER,DB_PASS,DB_NAME - Пути к файлам:
UPLOAD_PATH— корневая папка загрузокCOVERS_PATH/COVERS_URL— обложки книгAVATARS_PATH/AVATARS_URL— аватары пользователей
- Адрес сайта:
SITE_URL - Имя приложения:
APP_NAME= "Web Writer"
🛠 Дальнейшее развитие
- Планирую вынести работу с сущностями (книги, главы, серии, пользователи) в контроллеры.
- Создать единую точку входа для приложения.
❗ Поддержка
Все ошибки и предложения шлите в issue
📜 Лицензия
Приложение распространяется под лицензией AGPLv3.