diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 96aaa35d..a19e1659 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,7 +1,7 @@ --- name: Feature Request about: Suggest an idea for this project -title: "Feature Request: [Your feature name]" +title: "Feat Req: [Your feature name]" labels: "" assignees: JeelDobariya38 --- diff --git a/.github/ISSUE_TEMPLATE/feedback---question---help-wanted.md b/.github/ISSUE_TEMPLATE/feedback---question---help-wanted.md index b57eec62..a0671a8d 100644 --- a/.github/ISSUE_TEMPLATE/feedback---question---help-wanted.md +++ b/.github/ISSUE_TEMPLATE/feedback---question---help-wanted.md @@ -19,7 +19,7 @@ describe in short paragraph, what you are write or what question or concern you - **What is app version you use?** ............ - **What is the device and what version of android you use?** ......... -## Thoughts +## Thought Process (Raw Thoughts) describe your thought and feedback related to app. if you have question then delete this section and fill the question section... diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a8f8245b..661bfbf3 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,20 +1,13 @@ # Changes Made -- summary 1. -- summary 2. +- ... +- ... - ... -> Summary here, should be in one line (write concisely so that reviewer without take look at code, can -> say/determine what changed).. -> summary above should provide structure overview that one can read and understand what changed. -> summary should not be a detail guide, just short description. -> you can provide further information in notes section or it would be explicitly ask in pr comments at -> time of review if need..) - -# Breaking Changes +## Breaking Changes / Compatibility -- [Write about any breaking changes, like architecture changes or database changes etc.. If none, remove the section completely]. +[write about breaking changes, if there are any.. like architecture changes or database changes etc..]. ## Notes -[write notes if any, otherwise remove the section] +[write notes if any..] diff --git a/README.md b/README.md index 16f69454..9f9c5373 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ > It is just a open source project. An is current under active development. > Please, consider using it for fun, and not for real password management. (until, we officially > release a stable release) +> +> Cuz, **`data is stored unencrypted`.. we planning to add encryption soon.**
@@ -11,6 +13,7 @@ ![Static Badge](https://img.shields.io/badge/Release-Prototype-blue) [![Android CI/CD](https://github.com/PasscodesApp/Passcodes/actions/workflows/build-apks.yml/badge.svg)](https://github.com/PasscodesApp/Passcodes/actions/workflows/build-apks.yml) +[![CodeQL](https://github.com/PasscodesApp/Passcodes/actions/workflows/codeql.yml/badge.svg)](https://github.com/PasscodesApp/Passcodes/actions/workflows/codeql.yml) ![Visitor Counter (@hehuapei/visitor-badge)](https://visitor-badge.laobi.icu/badge?page_id=JeelDobariya38.Passcodes&format=true)
@@ -19,15 +22,13 @@ A android app that take down the headache of remembering passwords. It is open s help you in keeping your passwords safe and secure, in your own local storage without ever needing to push them to cloud. +[Visit Website](https://jeeldobariya38.github.io/Passcodes-Website/) + > What we think of passcodes? > Password management is one such thing that is as simple as remember a password yet, it very > important topic in term of security. So, we as developer of passcodes think to streamline and > securing the process as much as -> possible. [Read more](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/other-docs/project-overview.md) - -## Website - -[Visit Website](https://jeeldobariya38.github.io/Passcodes-Website/) +> possible. [Read more](https://passcodesapp.github.io/Passcodes-Docs/other-docs/project-overview/) ## Screen Shots @@ -40,36 +41,35 @@ to push them to cloud. ## Compatibility -**Compile Sdk**: `Android 16 (API level 36)` +- **Compile Sdk**: `Android 16 (API level 36)` +- **Recommend**: `Android 14` -``` -Android 8+ (Minimum) [API level 26+] -Android 14 [API level 34] (we support offically) +`Android 8+` [API level 26+] -> `Android 14` [API level 34] (we support offically) -Note: high version can still run, but are not guaranteed offically. -``` +Note: high versions can still run, but we are not guaranteed offically. ## Features - [ ] Intuitive UI. - [ ] Update Checkers & Manager. - [x] Password Management. (Current Priority) +- [x] Autofill. - [ ] Secure File. (Least Priority, Because it include permission. Which, I am as developer not - familiar with 😂) - - Could be Image. (JPG. PNG ....) - - Could be Video. - - Could any Binary File. (more like won't be a text file) + familiar with 😂) + - Could be Image. (JPG. PNG ....) + - Could be Video. + - Could any Binary File. (more like won't be a text file) - [ ] Other Secret Info Management. - - Could be note. (txt file) - - Could be any info that can encode as key & value. - ```json - { - "key": "SECRET API KEY", - "content": "qwerty-let-say", - "created-at": "...", - "updated-at": "..." - } - ``` + - Could be note. (txt file) + - Could be any info that can encode as key & value. + ```json + { + "key": "SECRET API KEY", + "content": "qwerty-let-say", + "created-at": "...", + "updated-at": "..." + } + ``` - [ ] NON Secret Info Store. - [ ] Encryption and Decryption. - [ ] Backup Manager. @@ -92,7 +92,7 @@ Note: high version can still run, but are not guaranteed offically. It was most shortest and sweetest description (I have ever crafted), For more detailed description, See the -file [installing.md](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/installing.md) +file [installing.md](https://passcodesapp.github.io/Passcodes-Docs/user-docs/installing/) in `PasscodesApp/Passcodes-Docs`. ## Building The App @@ -106,21 +106,21 @@ in `PasscodesApp/Passcodes-Docs`. 4. For code documentation and support docs, check the `docs/` folder in our repository. It was general, intuitive, short and sweet description, For more detailed description, Visit the -file [building.md](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/dev-docs/building.md) in +file [building.md](https://passcodesapp.github.io/Passcodes-Docs/dev-docs/building/) in `PasscodesApp/Passcodes-Docs`. ## Support Docs You can checkout support docs, provided -in [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs) Or You can even +in [@github:PasscodesApp/Passcodes-Docs](https://passcodesapp.github.io/Passcodes-Docs) Or You can even seek help on our [telegram community](https://t.me/passcodescommunity) ## Changelog & Release Notes - Professional - ChangeLog: [here](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/changelog.md) + ChangeLog: [here](https://passcodesapp.github.io/Passcodes-Docs/user-docs/changelog/) - Casual Release - Notes: [here](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/release-notes.md) + Notes: [here](https://passcodesapp.github.io/Passcodes-Docs/user-docs/release-notes/) ## Contribution Are Appreciated!!! @@ -139,22 +139,22 @@ seek help on our [telegram community](https://t.me/passcodescommunity) > For more, information on what kind of contribution we approve or allow, please open a issue in our > repo. that way you avoid wasting your time... > -> [Read More](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/other-docs/open-contributing-timeline.md) +> [Read More](https://passcodesapp.github.io/Passcodes-Docs/other-docs/open-contributing-timeline/) By, contributing to project you accept -the [Terms For Contributions](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/other-docs/terms-for-contributions.md), [CONTRIBUTING.md](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/CONTRIBUTING.md) & [MIT License](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/LICENSE.txt). +the [Terms For Contributions](https://passcodesapp.github.io/Passcodes-Docs/other-docs/terms-for-contributions/), [CONTRIBUTING.md](https://passcodesapp.github.io/Passcodes-Docs/CONTRIBUTING/) & [MIT License](https://passcodesapp.github.io/Passcodes-Docs/LICENSE/). And also have look -at [Open Contributing Timeline](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/other-docs/open-contributing-timeline.md). +at [Open Contributing Timeline](https://passcodesapp.github.io/Passcodes-Docs/other-docs/open-contributing-timeline/). ## Security Policy Available here -in [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/SECURITY.md). +in [PasscodesApp/Passcodes-Docs](https://passcodesapp.github.io/Passcodes-Docs/SECURITY/). ## License Passcodes Project is license -under [MIT](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/LICENSE.txt) License. +under [MIT](https://passcodesapp.github.io/Passcodes-Docs/LICENSE/) License. Downloading Or Use the app or any associated stuff would mean, you are okay and have accepted the license terms. diff --git a/changelog.md b/changelog.md index c102cd9c..152666b2 100644 --- a/changelog.md +++ b/changelog.md @@ -1,209 +1,24 @@ # Changelog -All notable changes to this project will be documented in this file. - -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -We don't strictly follow them. but the exceptions are very less, very intuitive, obvious -and well documented in our release workflow docs. - > [!NOTE] -> This is a raw version of the file.. +> This is a raw & incomplete version of the file.. > -> Final version can be found over -> -at [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/changelog.md) - -## v1.1.2 - Alpha (Nov 15, 2025) - -
- View Internal Details - - ``` - Pacakage Name = "com.jeeldobariya.passcodes" - Min Android = 8.0 (API level 26) - Max Android = 14 (API level 34) - Version Code = 3 - Version Name = "v1.1.2-Alpha" - Master Database Version = "v1" - ``` - -
- -### Breaking Changes - -- **Migrate to DataStore**: changed the way how setting and feature flag were been storage - previously, we use shared preferences but - now we use datastore which will be more modern way to store such data... but this will also mean - that your previous setting will be - not available anymore. we have decide this break changes, because app settings can be restored - again (in like few minutes). [@JeelDobariya38] - -### Added - -#### Preview Features - -- **Autofill System (Preview Feature)**: added a autofill service to autofill user's credentials on - the fly. [@hexCode63] - -- **Jetpack Compose (Preview Feature)**: added jetpack compose UI & even added a toggle to switch to - this new UI. - but it would be worthless to do so, because it just has a single screen.. *this feature is mainly - for very earlier testing*. [@JeelDobariya38] - -### Changed - -- **MVI Flavored - Clean Architecture**: migrated the codebase to make it more scalable, - extendable & readable. - This will enable us to create better features faster & make a strong base for faster - iteration. [@JeelDobariya38] - -- **Java 21**: migrated the code for passcodes app now compile to java 21. previously it was - compiling to java 11. This should improve performance & efficiency a bit. [@JeelDobariya38] - -- **Improved Performance**: Improve performance & better responsiveness of UI (less of density - pixel, more of scalable pixel measurements). [@JeelDobariya38] - -## v1.1.1 - Alpha (Sept 11, 2025) - -
- View Internal Details - - ``` - Pacakage Name = "com.jeeldobariya.passcodes" - Min Android = 8.0 (API level 26) - Max Android = 14 (API level 34) - Version Code = 2 - Version Name = "v1.1.1-Alpha" - Master Database Version = "v1" - ``` - -
- -### Fixed - -- **Fixed Import Passwords**: fixed the bug that was not allowing user to select csv files - from file picker. due to incorrect mimetype in code.. [@JeelDobariya38] - -## v1.1.0 - Alpha (Sept 1, 2025) - -
- View Internal Details - - ``` - Pacakage Name = "com.jeeldobariya.passcodes" - Min Android = 8.0 (API level 26) - Max Android = 14 (API level 34) - Version Code = 2 - Version Name = "v1.1.0-Alpha" - Master Database Version = "v1" - ``` - -
- -### Added - -- **Improved UI/UX**: improved view password screen's visual feel, also adjust the button colors a - bit. [@JeelDobariya38] - -- **Added Feature Flagging**: given user a control on whether they wanna latest experience or stable - experience. added a way for launching preview features without worry about their - stability. [@JeelDobariya38] - -- **Update Checking**: made a basic update checker that help users to stay up to date with latest - release & also notify user about already reported security vulnerability using pre-release - mechanism. [@JeelDobariya38] - -#### Preview Features - -- **Copy Button (preview feature)**: added a copy button for copying passwords for easy of use. but - as it - is potential threat to security, so made it as a preview feature. [@JeelDobariya38] - -- **G-Passwords Import/Export (preview feature)**: added a import/export feature. which is also - compatible with google passwords. I have test it with my google password setup. but, I am not sure - weather this will run in every edge case or not. So, it is a preview feature for - now. [@JeelDobariya38] - -### Notes - -- **Official Github Organization (Aug 31, 2025)**: migrate project & repository from - `JeelDobariya38 (personal account)` - to `PasscodesApp (my organization)` for better development and governance of the project. - -## v1.0.0 - Stable (Aug 16, 2025) - -
- View Internal Details - - ``` - Pacakage Name = "com.jeeldobariya.passcodes" - Min Android = 8.0 (API level 26) - Max Android = 14 (API level 34) - Version Code = 1 - Version Name = "v1.0.0-Stable" - Master Database Version = "v1" - ``` - -
- -### Added - -- **Localized App**: added language translation for English, Chinese, Hindi, Indonesian, Japanese, - Korean, - German, Spanish, Vietnamese. [@JeelDobariya38]. - -- **Improved UI/UX**: added confirmation dialogs for destructive actions, improved support for - light & dark - theme with additional minor changes. [@JeelDobariya38 & @kudanilll]. - -- **New Icon**: rebanded the app as passcodes with a new visual app icon. [@JeelDobariya38]. - -### Changed - -- **Migrated Package Name**: migrate package name from `com.passwordmanager` to - `com.jeeldobariya.passcodes`. [@JeelDobariya38]. - -- **Improve Safety By Kotlin Implementation**: move away from `Java` to `Kotlin` - Language. [@JeelDobariya38]. - -- **Improve Data Storing Process**: move away from `SqliteDatabase` to `Room` Library for better - datastorage & security. [@JeelDobariya38]. - -## v0.1.0 - Alpha (Aug 26, 2024) [YANKED RELEASE] - -
- View Internal Details - - ``` - Pacakage Name = "com.passwordmanager" - Min Android = 8.0 (API level 26) - Max Android = 13 (API level 33) - Version Code = 1 - Version Name = "0.1.0-Alpha" - Master Database Version = "v1" - ``` - -
- -### Added +> Final version can be found over at [@github:PasscodesApp/Passcodes-Docs](https://passcodesapp.github.io/Passcodes-Docs/user-docs/changelog/) -- **App Icon Creation**: designed and implemented the initial app icon, providing the application - with a recognizable visual identity. [@HamadaNative]. +> previously, we were mostly writing changelog at the end time. when drafting a new release +> and sometimes things are missed so from now on.. **we are going to write raw changelog as we go...** -- **Basic App Structure**: established the foundational architecture of the app, including the main - entry point and initial setup. [@JeelDobariya38]. +--- -- **Main Page Development**: developed the main page of the app, including basic UI components and - initial layout. [@JeelDobariya38]. +## [Unreleased] -- **Basic Password Store**: developed a database to store the passwords data. [@kudanilll]. +- Update dependency.. by @dependabot. +- Made two layout support in jetpack compose. by @JeelDobariya38 +- Fixed autofill service. by @JeelDobariya38 & @hexCode63. +- Improve CI/CD by @JeelDobariya38. -- **Basic Design System**: developed a basic material 2 design system for consistency in app's - feel & look. [@HamadaNative]. +--- -### Notes +## xxx-xxx - END - xxx-xxx -- This was the initial alpha pre-release, focusing more on setting up the basic structure and key - visual - elements of the app. (`Proof Of Concept`). +Final version can be found over at [@github:PasscodesApp/Passcodes-Docs](https://passcodesapp.github.io/Passcodes-Docs/user-docs/changelog/) diff --git a/docs/release-notes.md b/docs/release-notes.md deleted file mode 100644 index 61767ff5..00000000 --- a/docs/release-notes.md +++ /dev/null @@ -1,121 +0,0 @@ -# Release Notes - -Here, You will find short ad sweet and casual `tldrs` for release notes or changelog. -For more details and more professional tone, see [changelog.md](/changelog.md). - -> [!NOTE] -> This is a raw version of the file.. -> -> Final version is over -> on [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/release-notes.md) - -## v1.1.1-Alpha (Sept 11, 2025) - -
- View Internal Details - - ``` - Pacakage Name = "com.jeeldobariya.passcodes" - Min Android = 8.0 (API level 26) - Max Android = 14 (API level 34) - Version Code = 2 - Version Name = "v1.1.1-Alpha" - Master Database Version = "v1" - ``` - -
- -`TL;DR`: Sorry for delay, but we have fix import files feature... - -We are very sorry for the delay.. we have officially fix the import password csv file selection -bug... - -In big project, such small mistakes/things happens.. so, ignore it please... - -## v1.1.0-Alpha (Sept 1, 2025) - -
- View Internal Details - - ``` - Pacakage Name = "com.jeeldobariya.passcodes" - Min Android = 8.0 (API level 26) - Max Android = 14 (API level 34) - Version Code = 2 - Version Name = "v1.1.0-Alpha" - Master Database Version = "v1" - ``` - -
- -`TL;DR`: Design Improvement.. | Will work with google passwords.... | We are officially an -organization on Github from `Aug 31, 2025`.... - -This is our first **official release after becoming an organization on github...** this release has -feature like import & export passwords from google passwords app... this is also a alpha release and -both features (copy password & import export password) are disable by default due to security -threats... they can be turn on if you wish... - -Also as the passcodes have change from just my personal hobby project to official organization.. this -release is step for us to move to open source and open to contribute... and more importantly it -reflect, my long term vision with passcodes as a project... what it means? upcoming things will be -more fascinating to view and to be part of... and also the app will have more long term support... ( -if you ignore, the fact that I am not verified developer as of "1/9/25 by google"... but will do it -in near time...) - -Organization is name **PasscodesApp and not Passcodes. Because, it not available on github.......** - -Stick to watch and observe passcodes upcoming -progress... [Telegram](https://t.me/passcodescommunity) - -## v1.0.0-Stable (Aug 16, 2025) - -
- View Internal Details - - ``` - Pacakage Name = "com.jeeldobariya.passcodes" - Min Android = 8.0 (API level 26) - Max Android = 14 (API level 34) - Version Code = 1 - Version Name = "v1.0.0-Stable" - Master Database Version = "v1" - ``` - -
- -`TL;DR`: Our first stable release.. | Not much has change in terms of look and feature.. | Name of -project has changed to "Passcodes".. - -This is our first stable release, even though it look and behave same as prototype release. -it now more stable and reliable as the data storage part is now tested and optimised and uses -more modern approach (room library).. -things have change internally also... like app was first build using java.. but, now it is build -using kotlin. -now, you can also switch theme and languages in app.. -also improve UI/UX by providing help text.. especially as you all have question like "what is -domain?" "what can i write in domain?" and so on..... - -## v0.1.0-Alpha (Aug 26, 2024) - -
- View Internal Details - - ``` - Pacakage Name = "com.passwordmanager" - Min Android = 8.0 (API level 26) - Max Android = 13 (API level 33) - Version Code = 1 - Version Name = "0.1.0-Alpha" - Master Database Version = "v1" - ``` - -
- -`TL;DR`: Our first initial release.. | Prototype release.. - -It a prototype release which mean it can have bugs... -It has all core features, like create, read, update and delete passwords... -It has basic ui that allow you do do things, really intuitively and more structure... -But structure and intuitively doesn't necessary means modern ui... ui is now so cool but has -structure... diff --git a/docs/security-guide.md b/docs/security-guide.md deleted file mode 100644 index d35c44a9..00000000 --- a/docs/security-guide.md +++ /dev/null @@ -1,42 +0,0 @@ -# Security Guide - -> [!IMPORTANT] -> This file is no longer valid and is bit old.. take look -> at [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/security-guidelines.md) -> for latest changes. -> -> This file will be deleted in Nov, 2025.. - -Here, In this file, You can find the information about security concern that arise with saving your -password with passcodes app. - -> [!warning] -> Firstly, The passcodes is open source project and is currently under active development. So, one -> is solely responsible for share there information with passcodes application. - -We as developers, recommended you to wait, for its stable release. before full trusting passcodes -with yous your passwords data. - -## Consideration - -While, save your password with passcodes application. you should consider or should have knowledge -of following things. - -- Project is license under MIT License. which means that application is given - `as it is, without any warranty or guarantee` and is openly/freely available to redistribution or - modify. (but you need to have a copy of original license in it) -- With passcodes, your password are as safe as you write it down on pieces of paper or in a txt file - digitally. which means that, `your information is not specially protected.` - -## Recommendation - -Here, are the thing we recommend. - -- lock passcodes app, using your phone's settings app. it will make it hard for attackers to see - your passwords. - -- if you lock the app, then use a different password, then the one you have on your lock screen. it - make it even more safe. - -- also, if you don't use the app often, it's recommended to hide the app using your phone settings. ( - it is bit inconvenient but at the end of day it pays off as safety)