Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
mmarif4u committed Jul 2, 2024
1 parent 144bf95 commit dc9458f
Show file tree
Hide file tree
Showing 115 changed files with 5,707 additions and 2 deletions.
196 changes: 196 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
# Built application files
*.apk
*.ap_
*.aab

# Release dir
app/release/*
app/free/*

# Pro dir
app/premium/*

# Files for the ART/Dalvik VM
*.dex

# Java class files
*.class

# Generated files
bin/
gen/
out/

# Gradle files
.gradle/
build/

# Local configuration file (sdk path, etc)
local.properties

# Proguard folder generated by Eclipse
proguard/

# Log Files
*.log

# Android Studio Navigation editor temp files
.navigation/

# Android Studio captures folder
captures/

# IntelliJ
*.iml
.idea/*
.idea/workspace.xml
.idea/tasks.xml
.idea/gradle.xml
.idea/assetWizardSettings.xml
.idea/dictionaries
.idea/libraries
.idea/caches
!.idea/codeStyles

# Keystore files
# Uncomment the following lines if you do not want to check your keystore files in.
*.jks
*.keystore

# External native build folder generated in Android Studio 2.2 and later
.externalNativeBuild

# Google Services (e.g. APIs or Firebase)
google-services.json

# Freeline
freeline.py
freeline/
freeline_project_description.json

# fastlane
fastlane/report.xml
fastlane/Preview.html
fastlane/screenshots
fastlane/test_output
fastlane/readme.md

### Android Patch ###
gen-external-apklibs

### AndroidStudio ###
# Covers files to be ignored for android development using Android Studio.

# Built application files

# Files for the ART/Dalvik VM

# Java class files

# Generated files

# Gradle files
.gradle

# Signing files
.signing/

# Local configuration file (sdk path, etc)

# Proguard folder generated by Eclipse

# Log Files

# Android Studio
/*/build/
/*/local.properties
/*/out
/*/*/build
/*/*/production
*.ipr
*~
*.swp

# Android Patch

# External native build folder generated in Android Studio 2.2 and later

# NDK
obj/

# IntelliJ IDEA
*.iws
/out/

# User-specific configurations
.idea/caches/
.idea/libraries/
.idea/shelf/
.idea/.name
.idea/compiler.xml
.idea/copyright/profiles_settings.xml
.idea/encodings.xml
.idea/misc.xml
.idea/modules.xml
.idea/scopes/scope_settings.xml
.idea/vcs.xml
.idea/jsLibraryMappings.xml
.idea/datasources.xml
.idea/dataSources.ids
.idea/sqlDataSources.xml
.idea/dynamic.xml
.idea/uiDesigner.xml

# OS-specific files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db

# Legacy Eclipse project files
.classpath
.project
.cproject
.settings/

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.war
*.ear

# virtual machine crash logs (Reference: http://www.java.com/en/download/help/error_hotspot.xml)
hs_err_pid*

## Plugin-specific files:

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Mongo Explorer plugin
.idea/mongoSettings.xml

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Crowdin
crowdin.yml

### AndroidStudio Patch ###

!/gradle/wrapper/gradle-wrapper.jar

# End of https://www.gitignore.io/api/android,androidstudio

# Crowdin Config
crowdin.yml
63 changes: 61 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,61 @@
# nexnotes
A simple and free native Android client for taking notes
[![License: GPL v3](https://raw.githubusercontent.com/Swatian/nexnotes/main/assets/license.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Release](https://img.shields.io/badge/dynamic/json.svg?label=release&url=https://api.github.com/repos/Swatian/nexnotes/releases/tags&query=$[0].tag_name)](https://github.com/Swatian/nexnotes/releases)

[<img alt="Become a Patreon" src="https://raw.githubusercontent.com/Swatian/nexnotes/main/assets/patreon.png" height="40"/>](https://www.patreon.com/mmarif) [<img alt="Buy me a coffee" src="https://raw.githubusercontent.com/Swatian/nexnotes/main/assets/buy-me-a-coffee.png" height="40"/>](https://www.buymeacoffee.com/mmarif)

# Nex Notes - Android client for taking notes

Nex Notes is a simple, free and open-source Android client for taking quick and beautiful notes.
Nex Notes is licensed under the GPLv3 License. Please refer to the LICENSE file for the full text of the license.

## Downloads

[<img alt='Get it on Google Play' src='https://raw.githubusercontent.com/Swatian/nexnotes/main/assets/google-play.png' height="80"/>](https://play.google.com/store/apps/details?id=com.swatian.nexnotes.premium)
[<img alt='Download builds and releases' src='https://raw.githubusercontent.com/Swatian/nexnotes/main/assets/apk-badge.png' height="82"/>](https://github.com/Swatian/nexnotes/releases)

## Features

- Free and open source
- Topics for easy management
- Biometric lock
- Localized
- Search by title, content and topic

## Contributing

[Contributing](https://github.com/Swatian/nexnotes/wiki/Contributing)

## Translation

You can translate Nex Notes to your native language.

We use [Crowdin](https://crowdin.com/project/nexnotes) for translations. If your language is not listed, please request to add it to the project [here](https://github.com/Swatian/nexnotes/issues).

**Link: https://crowdin.com/project/nexnotes**

## Screenshots:

[<img src="https://raw.githubusercontent.com/Swatian/nexnotes/main/metadata/en-US/images/phoneScreenshots/001.png" alt="001.png" width="200"/>](https://raw.githubusercontent.com/Swatian/nexnotes/main/metadata/en-US/images/phoneScreenshots/001.png) | [<img src="https://raw.githubusercontent.com/Swatian/nexnotes/main/metadata/en-US/images/phoneScreenshots/002.png" alt="002.png" width="200"/>](https://raw.githubusercontent.com/Swatian/nexnotes/main/metadata/en-US/images/phoneScreenshots/002.png) | [<img src="https://raw.githubusercontent.com/Swatian/nexnotes/main/metadata/en-US/images/phoneScreenshots/003.png" alt="003.png" width="200"/>](https://raw.githubusercontent.com/Swatian/nexnotes/main/metadata/en-US/images/phoneScreenshots/003.png) | [<img src="https://raw.githubusercontent.com/Swatian/nexnotes/main/metadata/en-US/images/phoneScreenshots/004.png" alt="004.png" width="200"/>](https://raw.githubusercontent.com/Swatian/nexnotes/main/metadata/en-US/images/phoneScreenshots/004.png)
---|---|---|---

## Links

[Website](https://nexnotes.swatian.com/)
[Wiki](https://github.com/Swatian/nexnotes/wiki/)

## Thanks

Thanks to all the open source libraries, contributors, and donors.

#### Open source libraries

- [noties/Markwon](https://github.com/noties/Markwon)
- [ocpsoft/prettytime](https://github.com/ocpsoft/prettytime)
- [vdurmont/emoji-java](https://github.com/vdurmont/emoji-java)

#### Icon sets

- [tabler/tabler-icons](https://github.com/tabler/tabler-icons)

[Follow me on Fediverse - mastodon.social/@mmarif](https://mastodon.social/@mmarif)

*All trademarks and logos are the properties of their respective owners.*
1 change: 1 addition & 0 deletions app/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/build
95 changes: 95 additions & 0 deletions app/build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
plugins {
alias(libs.plugins.android.application)
id "com.diffplug.spotless" version "6.25.0"
}

android {
namespace 'com.swatian.nexnotes'
compileSdk 34

defaultConfig {
applicationId "com.swatian.nexnotes"
minSdk 27
targetSdk 34
versionCode 10
versionName "1.0"

testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
}

flavorDimensions = ["default"]
productFlavors {
free {
applicationId "com.swatian.nexnotes"
}
premium {
applicationId "com.swatian.nexnotes.premium"
}
}

buildTypes {
release {
minifyEnabled false
shrinkResources false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
compileOptions {
coreLibraryDesugaringEnabled = true
sourceCompatibility JavaVersion.VERSION_11
targetCompatibility JavaVersion.VERSION_17
}
buildFeatures {
viewBinding true
}
}

dependencies {

implementation libs.appcompat
implementation libs.material
implementation libs.constraintlayout
implementation libs.lifecycle.livedata.ktx
implementation libs.lifecycle.viewmodel.ktx
implementation libs.navigation.fragment
implementation libs.navigation.ui
implementation libs.notiesmarkwon.core
implementation libs.notiesmarkwon.ext.latex
implementation libs.notiesmarkwon.ext.strikethrough
implementation libs.notiesmarkwon.ext.tables
implementation libs.notiesmarkwon.ext.tasklist
implementation libs.notiesmarkwon.ext.simple
implementation libs.notiesmarkwon.html
implementation libs.notiesmarkwon.image
implementation libs.notiesmarkwon.image.glide
implementation libs.notiesmarkwon.linkify
implementation libs.notiesmarkwon.recycler
implementation libs.notiesmarkwon.recycler.table
implementation libs.notiesmarkwon.editor
implementation libs.prettytime
implementation libs.room.db
implementation libs.annotation
annotationProcessor libs.room.compiler
implementation libs.biometric
implementation libs.browser
coreLibraryDesugaring libs.desugar.jdk.libs
implementation libs.emoji.java
implementation libs.swiperefreshlayout

testImplementation libs.junit
androidTestImplementation libs.ext.junit
androidTestImplementation libs.espresso.core
}

spotless {
java {
target 'src/**/*.java'

importOrder('android', 'androidx', 'com', 'junit', 'net', 'org', 'java', 'javax', '', '\\#')

removeUnusedImports()
googleJavaFormat().aosp()
indentWithTabs()
formatAnnotations()
}
}
21 changes: 21 additions & 0 deletions app/proguard-rules.pro
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
# public *;
#}

# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable

# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile
Loading

0 comments on commit dc9458f

Please sign in to comment.