A notes app that implements compose, architecture

by androidexample

ComposeNotesAppRetrofit ?

Notes App That’s Built With Kotlin to keep and organize user’s notes. This repository contains a Notes App This is an educational App.Use and run this App to learn more about Apps design and best practices you must follow.That’s built with Kotlin language with compose, That’s implements Coroutines,Retrofit for HTTP requests,ktor-client for WebSocket requests,clean architecture,hilt,StateFlow,Navigation component,etc… this is client side you can find server side as api built with KTOR here -> SocketNotesApi this project implement http and websocket you can find the same API but without websocket(Http requests only) here ->HttpNotesApi

Features

  • Login with email and password
  • Signup with email and password
  • Search
  • Add Notes
  • Get Notes with realtime changes
  • Edit Notes
  • Change Note Color
  • Add Link
  • Add Image
  • Delete Note
  • Validate WebLink
  • Validate Email And Password
  • Validate Empty Fields

App Overview

  • in this screen you can signin with email and password

  • in this screen you can signup with email and password

  • this screen view all user notes

  • this screen view note details and edit note

Bottom Sheet Content

Add Link

Fields Validation

Add Image

Built With ?

Project Structure

 noteappcompose
 ┣ data
 ┃ ┣ di
 ┃ ┃ ┗ modules
 ┃ ┃ ┃ ┣ CoroutinesModule.kt
 ┃ ┃ ┃ ┣ DatabaseModule.kt
 ┃ ┃ ┃ ┗ RepositoryModule.kt
 ┃ ┣ repositories
 ┃ ┃ ┣ NoteRepositoryImpl.kt
 ┃ ┃ ┗ UserRepositoryImpl.kt
 ┃ ┗ source
 ┃ ┃ ┣ local
 ┃ ┃ ┃ ┗ dataSource
 ┃ ┃ ┃ ┃ ┗ UserLocalDataSource.kt
 ┃ ┃ ┗ remote
 ┃ ┃ ┃ ┣ dataSource
 ┃ ┃ ┃ ┃ ┣ NoteSocketDataSource.kt
 ┃ ┃ ┃ ┃ ┣ NotesRemoteDataSource.kt
 ┃ ┃ ┃ ┃ ┗ UserRemoteDataSource.kt
 ┃ ┃ ┃ ┣ endPoints
 ┃ ┃ ┃ ┃ ┣ NotesApiService.kt
 ┃ ┃ ┃ ┃ ┗ UserApiService.kt
 ┃ ┃ ┃ ┣ requestModels
 ┃ ┃ ┃ ┃ ┣ AddNoteRequestModel.kt
 ┃ ┃ ┃ ┃ ┣ LoginRequestModel.kt
 ┃ ┃ ┃ ┃ ┗ RegisterRequestModel.kt
 ┃ ┃ ┃ ┗ responseModels
 ┃ ┃ ┃ ┃ ┣ BaseApiResponse.kt
 ┃ ┃ ┃ ┃ ┣ NoteResponseModel.kt
 ┃ ┃ ┃ ┃ ┗ UserResponseModel.kt
 ┣ domain
 ┃ ┣ models
 ┃ ┃ ┣ NoteModel.kt
 ┃ ┃ ┣ UserModel.kt
 ┃ ┃ ┗ ValidateResult.kt
 ┃ ┣ repositories
 ┃ ┃ ┣ NoteRepository.kt
 ┃ ┃ ┗ UserRepository.kt
 ┃ ┣ usecases
 ┃ ┃ ┣ AddEditNoteUseCase.kt
 ┃ ┃ ┣ GetAllNotesUseCase.kt
 ┃ ┃ ┣ GetNoteDetailsUseCase.kt
 ┃ ┃ ┣ IsUserSplashUseCase.kt
 ┃ ┃ ┣ LoginUseCase.kt
 ┃ ┃ ┣ RegisterUseCase.kt
 ┃ ┃ ┣ SearchUseCase.kt
 ┃ ┃ ┣ UploadImageUseCase.kt
 ┃ ┃ ┣ ValidateEmailUseCase.kt
 ┃ ┃ ┣ ValidateNoteDescriptionUseCase.kt
 ┃ ┃ ┣ ValidateNoteSubtitleUseCase.kt
 ┃ ┃ ┣ ValidateNoteTitleUseCase.kt
 ┃ ┃ ┣ ValidatePasswordUseCase.kt
 ┃ ┃ ┣ ValidateUserNameUseCase.kt
 ┃ ┃ ┗ ValidateWebLinkUseCase.kt
 ┃ ┗ utilitites
 ┃ ┃ ┗ Exceptions.kt
 ┣ presentation
 ┃ ┣ homeScreen
 ┃ ┃ ┣ components
 ┃ ┃ ┃ ┣ NoteItem.kt
 ┃ ┃ ┃ ┣ SearchField.kt
 ┃ ┃ ┃ ┗ StaggeredVerticalGrid.kt
 ┃ ┃ ┣ uiStates
 ┃ ┃ ┃ ┣ HomeUiEvent.kt
 ┃ ┃ ┃ ┣ NoteItemUiState.kt
 ┃ ┃ ┃ ┗ NotesUiState.kt
 ┃ ┃ ┣ HomeScreen.kt
 ┃ ┃ ┗ HomeViewModel.kt
 ┃ ┣ loginScreen
 ┃ ┃ ┣ components
 ┃ ┃ ┃ ┗ OutlineInputField.kt
 ┃ ┃ ┣ uiStates
 ┃ ┃ ┃ ┣ LoginUiEvent.kt
 ┃ ┃ ┃ ┗ LoginUiState.kt
 ┃ ┃ ┣ LoginScreen.kt
 ┃ ┃ ┗ LoginViewModel.kt
 ┃ ┣ noteDetailsScreen
 ┃ ┃ ┣ components
 ┃ ┃ ┃ ┣ BottomSheetItem.kt
 ┃ ┃ ┃ ┣ ColorBox.kt
 ┃ ┃ ┃ ┣ NoteInputField.kt
 ┃ ┃ ┃ ┣ ToolBarIconButton.kt
 ┃ ┃ ┃ ┗ UrlDialog.kt
 ┃ ┃ ┣ uiStates
 ┃ ┃ ┃ ┣ InputFieldUiState.kt
 ┃ ┃ ┃ ┣ LinkUiState.kt
 ┃ ┃ ┃ ┣ NoteDetailsEvent.kt
 ┃ ┃ ┃ ┗ NoteDetailsUiState.kt
 ┃ ┃ ┣ NoteDetailScreen.kt
 ┃ ┃ ┗ NoteDetailsViewModel.kt
 ┃ ┣ registerScreen
 ┃ ┃ ┣ components
 ┃ ┃ ┃ ┗ LoadingButton.kt
 ┃ ┃ ┣ uiStates
 ┃ ┃ ┃ ┣ RegisterUiEvent.kt
 ┃ ┃ ┃ ┗ RegisterUiState.kt
 ┃ ┃ ┣ RegisterScreen.kt
 ┃ ┃ ┗ RegisterViewModel.kt
 ┃ ┣ splashScreen
 ┃ ┃ ┣ uiStates
 ┃ ┃ ┃ ┗ SplashUiEvent.kt
 ┃ ┃ ┣ SplashScreen.kt
 ┃ ┃ ┗ SplashViewModel.kt
 ┃ ┣ theme
 ┃ ┃ ┣ Color.kt
 ┃ ┃ ┣ Theme.kt
 ┃ ┃ ┗ Type.kt
 ┃ ┗ utility
 ┃ ┃ ┣ Constants.kt
 ┃ ┃ ┗ Screen.kt
 ┣ MainActivity.kt
 ┗ NoteApp.kt

LICENSE


Copyright (c) 2022 adelayman1

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.```

GitHub

View Github