From fd9d6dfba311bb47ab46ae6149995cb7bd76d170 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Sat, 16 Aug 2025 22:43:06 +0530 Subject: [PATCH 1/3] chore: Create release.yml --- .github/release.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 00000000..48901655 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,24 @@ +# .github/release.yml + +changelog: + categories: + - title: Highlights 🌟 + labels: + - highlights + + - title: New Features 🚀 + labels: + - feature + - enhancement + + - title: Bug Fixes 🐛 + labels: + - bug + + - title: Documentation 📚 + labels: + - documentation + + - title: Other Changes + labels: + - "*" From 089b574856211361a99461a162164048b4f9ad1c Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Sat, 16 Aug 2025 22:46:00 +0530 Subject: [PATCH 2/3] chore: Create pull_request_template.md --- .github/pull_request_template.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..36c990f7 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,8 @@ +# Changes Made + +- summary 1. +- summary 2. + +# Notes + +[if any, none if remove section] From b5d11ebb4aebcc67934b7ab410a9f48f493602ee Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Sat, 16 Aug 2025 22:48:48 +0530 Subject: [PATCH 3/3] feat: add readme a security policy to assets --- app/src/main/assets/README.md | 119 ++++++++++++++++++++++++++++++++ app/src/main/assets/SECURITY.md | 8 +++ 2 files changed, 127 insertions(+) create mode 100644 app/src/main/assets/README.md create mode 100644 app/src/main/assets/SECURITY.md diff --git a/app/src/main/assets/README.md b/app/src/main/assets/README.md new file mode 100644 index 00000000..1898224d --- /dev/null +++ b/app/src/main/assets/README.md @@ -0,0 +1,119 @@ +# Passcodes + +[![Android CI/CD](https://github.com/JeelDobariya38/Passcodes/actions/workflows/build-apks.yml/badge.svg)](https://github.com/JeelDobariya38/Passcodes/actions/workflows/build-apks.yml) +![Visitor Counter (@hehuapei/visitor-badge)](https://visitor-badge.laobi.icu/badge?page_id=JeelDobariya38.Passcodes&format=true) + +> [!WARNING] +> It is just a open source project. An is current under active development. +> Please, consider using it for fun, and not for real password managment. (untill, we offically release a stable release) + +

+ passcodes play store banner +

+ +A android app that take down the headache of remembering passwords. It is open source solutions that help you in keeping your passwords safe and secure, in your own local storage without ever needing to push them to cloud. + +> 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](docs/project-overview.md) + +## Website + +[Vist Website](https://jeeldobariya38.github.io/Passcodes-Website/) + +## Screen Shots + +
+ View Here + + + + +
+ +## Compatibility + +**Compile Sdk**: `Android 16 (API level 36)` + +``` +Android 8+ (Minimum) [API level 26+] +Android 14 [API level 34] (we support offically) + +Note: high version can still run, but are not guaranteed offically. +``` + +## Features + +- [x] Intuitive UI. +- [ ] Update Checkers & Manager. +- [x] Password Management. (Current Priority) +- [ ] Secure File. (Least Priority, Because it include permission. Which, I am as developer not familar with 😂) + - Could be Image. (JPG. PNG ....) + - Could be Vidoe. + - 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", + "createdat": "...", + "updatedat": "..." + } + ``` +- [ ] NON Secret Info Store +- [ ] Encryption and Decryption. +- [ ] Backup Manager. +- [ ] Import/Export Passwords. +- [ ] Extensivity with custom database. +- [ ] Multiple Language Translation. +- [ ] Theme & Customization. +- [ ] Key Manager. +- [ ] Multi Platform Support. (KMP) + +## Installation Steps + +1. Go to our [github repository release page](https://github.com/JeelDobariya38/Passcodes/releases/latest). + +2. Download the apk for your phone. If Don't know the architecture of phone then download apk file that has universal in its name. + +3. Install the apk and you are ready to use the app. + +It was most shortest and sweetest description (I have ever crafted), For more detailed description, Vist the file [docs/installing.md](docs/installing.md) + +## Building The App + +1. Clone the repository on your machine. + +2. Open the project own your Android Studio. + +3. Follow the general step and build the app. + +4. For code documention and support docs, check the `docs/` folder in our repository. + +It was general, intuitive, short and sweet description, For more detailed description, Vist the file [docs/building.md](docs/building.md). + +## Support Docs + +You can checkout support docs, provided in [docs/](docs/) Or You can even seek help on our [telegram community](https://t.me/passcodescommunity) + +## Changelog & Release Notes + +- Professional ChangeLog: [here](https://github.com/JeelDobariya38/Passcodes/blob/main/changelog.md) +- Casual Release Notes: [here](https://github.com/JeelDobariya38/Passcodes/blob/main/docs/release-notes.md) + +## Contribution Are Appreciated!!! + +> [!IMPORTANT] +> Currently the project (more or less also me) is not ready for (code) contributions. +> This project is currently limited by my expertise & I am beginner. Meaning I don;t want others code in my codebase, that I don't understand, I am learning android and will surely learn basic off by start of 2026.. then i will allow the contibution to this repo... But as of now i don't admire code contribution. As I am beginner in android and might have difficuly understand code that not written by me... +> +> There are still other ways to contribute to project.. like by testing app, by contributing to documenation or more or less just by spreading the word around.. about the app. but, code contribution is limited from my side.... & I hope you can understand... +> +> For more, infomation on what kind of contribtuion we approve or allow, please open a issue in our repo. that way you avoid wasteing your time... + +By, contributing to project you accept the [CONTRIBUTING.md](https://github.com/JeelDobariya38/Passcodes/blob/main/CONTRIBUTING.md) & [MIT License](https://github.com/JeelDobariya38/Passcodes/blob/main/LICENSE.txt). + +## Licence + +Passcodes Project is license under [MIT](https://github.com/JeelDobariya38/Passcodes/blob/main/LICENSE.txt) License. Downloading the app would mean, you are okay and have accepted the license. diff --git a/app/src/main/assets/SECURITY.md b/app/src/main/assets/SECURITY.md new file mode 100644 index 00000000..83d1c6a0 --- /dev/null +++ b/app/src/main/assets/SECURITY.md @@ -0,0 +1,8 @@ +# Security Policy + +## Reporting a Vulnerability + +Report a vulnerability on a maintainer email. don't create a github issue or report publicly. + +- `dobariyaj34@gmail.com` +- `achmad24daniel@gmail.com`