Note App

Where you can write your daily notes

Contains

1. About Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contacts

About Project

Note app. This application allows you to store your daily notes. Every new entry is saved in local database and further that note is sent to backend server, where it is stored. Thanks to server you can access any note from any device, using your profile.

This app :

• Have its own server - NoteAppServer
• Encrypts your password using Hash and Salt
• Make sure, when you log in for the first time, it saves your credentials, so when you restart app it automaticly authenticates you.
• You can add/edit notes to local database, and then they will be saved in server.

Built With

This application is built in Android Studio version 2020.3.1 (Artic Fox) using :

• Kotlin
• Jetpack Compose version 1.0.0
• Courotines
• DaggerHilt
• Retrofit & OkHttp
• Timber
• Room
• Shared Preferences
• Live Data
• MVVM

For Backend NoteAppServer :

• Ktor
• MongoDB
• Courotines
• Commons Codec

Getting Started

Prerequisites

1. You need to install Android Studio version 2020.3.1 (Artic Fox) or newer version who supports Jetpack compose you can find installation step-by-step in following :

• Android Studio version 2020.3.1 (Artic Fox)

2. You need to install IntelliJ IDEA Version: 2021.2.2, you can download it here :

• IntelliJ IDEA

Installation

1. You need to clone Backend server, you can fing step-by-step here - NoteAppServer

2. Clone the repository using :

• Android studio file -> New -> Project from version control... And enter this https://github.com/OzolsUgis/NoteApp.git in URL

• Using terminal

   git clone https://github.com/OzolsUgis/NoteApp.git

!!! Check if your Port from backend server is the same as it is in utilities -> Constants -> BASE_URL

Contacts

Ugis Ozols - https://www.linkedin.com/in/ozols-ugis/

Project Link (NoteApp)- https://github.com/OzolsUgis/NoteApp.git

Project Link (NoteData) - https://github.com/OzolsUgis/NoteData.git