Skip to content

M0N3/project_note_client

Repository files navigation

ReadMe Project_Note
########################################################
Общая информация:
Клиент разработан для   платформы Android v4.0.0 и выше, сервер использует платформу node js v5.7.0,
использовалась IDE IntellIJ idea v15, и  система автоматической сборки Gradle.
Для разработки приложения и сервера использовались языки программирования Java и JavaScript.
Локальная база данных на клиенте – SQLite, выбрана за свою компактность и простоту работы, а также поддержку Android.
Серверная база данных – PostgreSQL, является open-source, поддерживается на многих платформах, базируется на языке SQL.
########################################################
Что было выполнено по заданию:
- Разработано клиент – серверное приложение
- Многопользовательская система (регистрация новых пользователей, авторизация)
- Для доступа к заметкам нужна авторизация
- У каждой заметки есть владелец
- Владелец может делать заметку общедоступной – ее могут посмотреть другие пользователи, сделав запрос по логину владельца, но изменить нельзя
- Пользователь может создавать, редактировать, удалять свои заметки
- Пользователь может создавать ярлыки, удалять их, прикреплять и откреплять к заметкам
- Пользователь может посмотреть список всех заметок
- Пользователь может посмотреть детали о заметке (дату создания, автора, доступ)
- В редактировании заметки пользователь может изменять название, текст, ярлыки, цвет, доступ
Что было добавлено самостоятельно:
- Поиск по заметкам и ярлыкам
- HELP  - помощь пользователю в пользовании программой
Что не было выполнено:
- Категории
- Прикрепление к заметкам медиа (картинки, видео, документы)
###########################################################
Особенности текущей реализации:
- Ярлыки можно добавлять как непосредственно при создании/редактировании  заметки, так и отдельно
- При удалении ярлыка, он автоматически удаляется со всех существующих заметок
- Ярлык можно добавить при его поиске в списке ярлыков, нажав кнопку поиск на клавиатуре телефона, если такой заметки еще не существует
- На сервере происходит проверка пользователей при регистрации/авторизации
- Заметки на сервере сохраняются только при первом создании и только при условии интернет-доступа в момент создания
- Для регистрации и первого входа нового пользователя в приложение нужно иметь интернет – доступ
###########################################################
Что нужно для работы сервера:
- node js последней версии
- PostgreSQL последней версии, с пользователем и созданной пустой БД
- Для корректного подключения БД к серверу нужно изменить первую строку в файле  database.js
    (ввести существующие имя пользователя и пароль, а также имя БД)
- В клиенте нужно изменить ip – адрес и порт по которому осуществляется доступ к серверу,
    сделать это можно просто изменив строку server_url в файле project_note_client\app\src\main\res\values\strings.xml
- В каталоге клиента есть apk файл (Project_Note.apk) для тестирования, который можно сразу запустить на устройстве,
    он настроен на мой домашний сервер, в нем уже присутствуют пару пользователей с заметками (Login: admin; Pass: admin; Login user; Pass: user),
    единственная проблема что домашний ip – адрес у меня меняется динамически, и сколько времени сервер будет работоспособен – неизвестно 
    (не забываем, что для первого входа или регистрации нужен доступ к интернету).
    P.S. Это был мой первый опыт работы с БД, клиент - серверной архитектурой, Android-ом и JavaScript, прошу сильно камнями не кидаться (:


About

Test project for trainee

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages