Skip to content
This repository has been archived by the owner on Apr 27, 2023. It is now read-only.
/ Yakser-Notepad Public archive

Notepad - простое веб-приложение на Flask, которое позволяет создавать текстовые заметки и помещать их в разные папки.

License

Notifications You must be signed in to change notification settings

Yakser/Yakser-Notepad

Repository files navigation

Notepad

Описание

Notepad - создавайте заметки, записывайте мысли, сохраняйте ссылки!

Notepad позволяет создавать папки и добавлять в них текстовые заметки.

Запуск

Запустить проект локально можно с помощью любой IDE или cmd.

PyCharm и др. IDE: стандартный запуск
cmd: python run.py

Также проект размещен на Heroku:

https://yakser-notepad.herokuapp.com/

Как использовать?

Notepad позволяет создавать папки и в них создавать текстовые заметки. Но для этого нужно авторизоваться (внизу кнопка Войти, затем Зарегистрироваться, если у Вас еще нет аккаунта).

Авторизация

Неавторизованному пользователю доступны только вкладки Главная и Справка. На них можно ознакомиться с приложением.

Вам придет письмо на указанную при регистрации электронную почту. В нем будет содержаться логин и пароль от Вашего аккаунта. Также при изменении пароля или удалении аккаунта будет отправлено уведомляющее письмо.

Главная

На Главной странице располагается список созданных папок (если вы только что зарегистрировались, то он пуст). Кликнув по иконке папки, можно посмотреть заметки, находящиеся в этой папке.

Чтобы создать папку, нужно перейти на вкладку Управление и нажать на кнопку плюс.

А чтобы создать заметку, нужно кликнуть по иконке папки, а затем по кнопке плюс. Заметки можно редактировать (кнопка карандаша) и удалять (кнопка крестика).

Папки и заметки можно фильтровать с помощью поиска по имени.

Управление

Тут происходит управление всеми папками, то есть добавление (кнопка плюс) и удаление (кнопка крестика).

Настройки

Отображают количество созданных заметок, папок, и дату последнего изменения.

Справка

Здесь находится основная информация о приложении и иллюстрации.

Профиль

Чтобы перейти в профиль, нужно навести курсор на иконку с тремя точками (в самом низу около логина). Затем в появившемся меню перейти в профиль. Редактировать профиль можно по соответствующей кнопке.

img.png

Выход и изменение пароля осуществляются через это же меню.

Описание API

REST-API

  • Получение списка всех пользователей /api/users

  • Получение одного пользователя по id /api/users/user_id

  • Редактирование и удаление пользователей

  • Получение списка всех папок и одной папки по id /api/folders, /api/folders/folder_id

  • Редактирование и удаление папок

  • Получение списка всех заметок и одной заметки по id /api/notes, /api/notes/note_id

  • Редактирование и удаление заметок

API тестировалось с помощью библиотеки pytest.

Навык Яндекс Алисы

Бот в общих чертах рассказывает о приложении Notepad - отправляет иллюстрации приложения, описание функционала и возможностей.

Навык также размещен на Heroku:

https://yakser-notepad-alice-skill.herokuapp.com/

Код бота находится в отдельной папке и его также можно запустить локально.

img.png img_1.png img.png

MomentJs

При разработке приложения использовалась библиотека MomentJs для языка JavaScript. Она нужна для работы с датами и временем. Благодаря этой библиотеке в приложении отображается время соответствующего часового пояса, а не время на сервере Heroku.

В папке /docs находятся файлы с более подробным описанием работы и скриншотами

About

Notepad - простое веб-приложение на Flask, которое позволяет создавать текстовые заметки и помещать их в разные папки.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published