https://github.com/cworld1/notie

Android note App complies with Material You specifications, developed using Java.
https://github.com/cworld1/notie

android java notes notes-app

Last synced: 12 months ago
JSON representation

Android note App complies with Material You specifications, developed using Java.

• Host: GitHub
• URL: https://github.com/cworld1/notie
• Owner: cworld1
• License: gpl-3.0
• Created: 2023-12-09T16:22:05.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-25T17:46:41.000Z (over 2 years ago)
• Last Synced: 2024-01-25T18:56:48.652Z (over 2 years ago)
• Topics: android, java, notes, notes-app
• Language: Java
• Homepage:
• Size: 1.1 MB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Notie

[![GitHub stars](https://img.shields.io/github/stars/cworld1/notie?style=flat-square)](https://github.com/cworld1/notie/stargazers)

[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/cworld1/notie?label=commits&style=flat-square)](https://github.com/cworld1/notie/commits)

[![Release version](https://img.shields.io/github/v/release/cworld1/notie?style=flat-square)](https://github.com/cworld1/notie/releases/latest)

[![GitHub license](https://img.shields.io/github/license/cworld1/notie?style=flat-square)](https://github.com/cworld1/notie/blob/main/LICENSE)

Android note App complies with Material You specifications, developed using Java.

| Screenshot                       | Screenshot                     |

| -------------------------------- | ------------------------------ |

| ![Multi select](./src/app-2.png) | ![App drawer](./src/app-3.png) |

| ![Settings](./src/settings.png)  | ![Note info](./src/note-2.png) |

![App wide dark screen](src/app-wide-dark.png)

![Note wide dark screen](src/note-wide-dark.png)

![Edit wide dark screen](src/edit-wide-dark.png)

## Download

See the releases.

[![Download](https://user-images.githubusercontent.com/74561130/137598555-649c77c7-1719-4aa3-8017-8b41283de730.png)](https://github.com/cworld1/notie/releases/latest)

## Local Development

Environment requirements:

- [SDK](https://developer.android.com/tools/releases/platforms): Android 14.0 ("UpsideDownCake")

  - Android SDK Platform 34

  - Sources for Android 34

  - Google APls Intel x86_64 Atom System Image

- [Android Gradle Plugin Version](https://developer.android.com/build/agp-upgrade-assistant): 8.1.4

- Gradle Version: 8.0

### 1. Clone the repository

```shell

git clone https://github.com/cworld1/notie.git

cd notie

```

### 2. Open the code using Android Studio

```shell

studio64 .

```

## Contributions

To spend more time coding and less time fiddling with whitespace, this project uses code conventions and styles to encourage consistency. Code with a consistent style is easier (and less error-prone!) to review, maintain, and understand.

### Be consistent

If the style guide is not explicit about a particular situation, the cardinal rule is to **be consistent**. For example, take a look at the surrounding code and follow its lead, or look for similar cases elsewhere in the codebase.

### Java

Follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html).

### XML

- 2 space indentation

- Resource naming (including IDs) is `lowercase_with_underscores`

- Attribute ordering:

  1.  `xmlns:android`

  2.  other `xmlns:`

  3.  `android:id`

  4.  `style`

  5.  `android:layout_` attributes

  6.  `android:padding` attributes

  7.  other `android:` attributes

  8.  `app:` attributes

  9.  `tool:` attributes

## Thanks

- [Android Developer Document](https://developer.android.com/)

- [Google Fonts Icons](https://fonts.google.com/icons)

- [Material Design](https://m3.material.io/)

- [Markwon](https://github.com/noties/Markwon)

## License

This project is licensed under the GPL 3.0 License.