Docs: Documented the Workflow

CONTRIBUTING.md

@@ -0,0 +1,129 @@
+# Contributing Guidelines
+
+*Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!* :octocat:
+
+### Contents
+
+- [Asking Questions](#bulb-asking-questions)
+- [Opening an Issue](#inbox_tray-opening-an-issue)
+- [Feature Requests](#love_letter-feature-requests)
+- [Triaging Issues](#mag-triaging-issues)
+- [Submitting Pull Requests](#repeat-submitting-pull-requests)
+- [Writing Commit Messages](#memo-writing-commit-messages)
+- [Code Review](#white_check_mark-code-review)
+- [Certificate of Origin](#medal_sports-certificate-of-origin)
+- [Credits](#pray-credits)
+
+> **This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.**
+
+## :bulb: Asking Questions
+
+See our [Community](https://t.me/passwordmanagercommunity) on telegram we appricate your question over there. In short, GitHub issues are not the appropriate place to debug your specific question, but should be reserved for filing bugs and feature requests.
+
+## :inbox_tray: Opening an Issue
+
+Before [creating an issue](https://github.com/JeelDobariya38/password-manager/issues/new), check if you are using the latest version of the project. If you are not up-to-date, see if updating fixes your issue first.
+
+### :lock: Reporting Security Issues
+
+Review our [Security Policy](SECURITY.md). **Do not** file a public issue for security vulnerabilities.
+
+### :beetle: Bug Reports and Other Issues
+
+A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report. :v:
+
+In short, since you are most likely a developer, **provide a ticket that you would like to receive**.
+
+- **Review the Documentation and Support Guide** before opening a new issue.
+
+- **Do not open a duplicate issue!** Search through existing issues to see if your issue has previously been reported. If your issue exists, comment with any additional information you have. You may simply note "I have this problem too", which helps prioritize the most common problems and requests. 
+
+- **Prefer using [reactions](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)**, not comments, if you simply want to "+1" an existing issue.
+
+- **Use [GitHub-flavored Markdown](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).** Especially put code blocks and console outputs in backticks (```). This improves readability.
+
+## :love_letter: Feature Requests
+
+Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted. We want to avoid [feature creep](https://en.wikipedia.org/wiki/Feature_creep). Your idea may be great, but also out-of-scope for the project. If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are welcome to submit a pull request to help!
+
+- **Do not open a duplicate feature request.** Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue.
+
+- Be precise about the proposed outcome of the feature and how it relates to existing features. Include implementation details if possible.
+
+## :mag: Triaging Issues
+
+You can triage issues which may include reproducing bug reports or asking for additional information, such as version numbers or reproduction instructions. Any help you can provide to quickly resolve an issue is very much appreciated!
+
+## :repeat: Submitting Pull Requests
+
+We **love** pull requests! Before [forking the repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests) for non-trivial changes, it is usually best to first open an issue to discuss the changes, or discuss your intended approach for solving the problem in the comments for an existing issue.
+
+For most contributions, after your first pull request is accepted and merged, you will be [invited to the project](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository) and given **push access**. :tada:
+
+*Note: All contributions will be licensed under the project's license.*
+
+- **Smaller is better.** Submit **one** pull request per bug fix or feature. A pull request should contain isolated changes pertaining to a single bug fix or feature implementation. **Do not** refactor or reformat code that is unrelated to your change. It is better to **submit many small pull requests** rather than a single large one. Enormous pull requests will take enormous amounts of time to review, or may be rejected altogether. 
+
+- **Coordinate bigger changes.** For large and non-trivial changes, open an issue to discuss a strategy with the maintainers. Otherwise, you risk doing a lot of work for nothing!
+
+- **Prioritize understanding over cleverness.** Write code clearly and concisely. Remember that source code usually gets written once and read often. Ensure the code is clear to the reader. The purpose and logic should be obvious to a reasonably skilled developer, otherwise you should add a comment that explains it.
+
+- **Follow existing coding style and conventions.** Keep your code consistent with the style, formatting, and conventions in the rest of the code base. Consistency makes it easier to review and modify in the future.
+
+- **Update the example project** if one exists to exercise any new functionality you have added.
+
+- **Add documentation.** Document your changes with code doc comments or in existing guides.
+
+- **Update the CHANGELOG** for all enhancements and bug fixes. Include the corresponding issue number if one exists, and your GitHub username. (example: "- Fixed crash in profile view. #123 @jessesquires")
+
+- **Use the repo's default branch.** Branch from and [submit your pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to the repo's default branch. `main`.
+
+- **[Resolve any merge conflicts](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)** that occur.
+
+- **Promptly address any CI failures**. If your pull request fails to build or pass tests, please push another commit to fix it. 
+
+- When writing comments, use properly constructed sentences, including punctuation.
+
+- Use spaces, not tabs.
+
+## :memo: Writing Commit Messages
+
+Please [write a great commit message](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716), we follow sematic commits but, don't enfore them.
+
+## :white_check_mark: Code Review
+
+- **Review the code, not the author.** Look for and suggest improvements without disparaging or insulting the author. Provide actionable feedback and explain your reasoning.
+
+- **You are not your code.** When your code is critiqued, questioned, or constructively criticized, remember that you are not your code. Do not take code review personally.
+
+- **Always do your best.** No one writes bugs on purpose. Do your best, and learn from your mistakes.
+
+- Kindly note any violations to the guidelines specified in this document. 
+
+## :medal_sports: Certificate of Origin
+
+*Developer's Certificate of Origin 1.1*
+
+By making a contribution to this project, I certify that:
+> I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
+
+## [No Brown M&M's](https://en.wikipedia.org/wiki/Van_Halen#Contract_riders)
+
+If you are reading this, bravo dear user and (hopefully) contributor for making it this far! You are awesome. :100: 
+
+To confirm that you have read this guide and are following it as best as possible, **include this emoji at the top** of your issue or pull request: :black_heart: `:black_heart:`
+
+## :pray: Credits
+
+Written by [@jessesquires](https://github.com/jessesquires). 
+
+**Please feel free to adopt this guide in your own projects. Fork it wholesale or remix it for your needs.**
+
+*Many of the ideas and prose for the statements in this document were based on or inspired by work from the following communities:*
+
+- [Alamofire](https://github.com/Alamofire/Alamofire/blob/master/CONTRIBUTING.md)
+- [CocoaPods](https://github.com/CocoaPods/CocoaPods/blob/master/CONTRIBUTING.md)
+- [Docker](https://github.com/moby/moby/blob/master/CONTRIBUTING.md)
+- [Linux](https://elinux.org/Developer_Certificate_Of_Origin)
+
+*We commend them for their efforts to facilitate collaboration in their projects.*

README.md

@@ -1,2 +1,30 @@
-# password-manager
-A android app that manages your password in local storage.
+# Password Manager
+
+A android app that take down the headace of remember passwords. It is open source solutions that help you in keep your passwords safe and secure in your own local storage without ever need to push you password to cloud.
+
+> [!WARNING]
+> It is just a open source project. An is under active development please, consider using it for fun and not for real password managment. (untill, we offically release a stable release)
+
+## Features
+
+- [ ] Intuitive UI.
+- [ ] Update Checkers.
+- [ ] Password Management. (current priority)
+- [ ] Other Info Management.
+- [ ] Backup Manager.
+- [ ] Import/Export Passwords.
+- [ ] Extensivity with custom database.
+
+## Installation Steps
+
+1. Go to our [github repository release page](https://github.com/JeelDobariya38/password-manager/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.
+
+## Contribution Are Appicated!!!
+
+By, contribuating to project you accept the [CONTRIBUTING.md](CONTRIBUTING.md) & [MIT License](LICENSE.txt).
+
+## Licence
+
+Password Manager Project is licence under [MIT](LICENSE.txt) Licence. Downloading the app would mean you are ok with the license.

SECURITY.md

@@ -0,0 +1,7 @@
+# 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`

app/src/main/res/layout/activity_main.xml

@@ -1,11 +1,11 @@
-<?xml version="1.0" encoding="utf-8"?>
 <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
 	xmlns:tools="http://schemas.android.com/tools"
 	android:layout_width="match_parent"
 	android:layout_height="match_parent"
 	android:gravity="center"
 	tools:context=".MainActivity">
 
+
 	<TextView
 		android:layout_width="wrap_content"
 		android:layout_height="wrap_content"

changelog.md

@@ -0,0 +1,12 @@
+# 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).
+
+## [Unreleased]
+
+### Added
+
+- Made a Main page of App by @HamadaNative

docs/database-design-guide.md

@@ -0,0 +1,100 @@
+# Database Design & Guide
+
+In this file, You will find the general structure & format in which app stores users data. Also you will you will find different schema of database.
+
+> Some feature are not supported in sqlite3 and some might be specfic to some database. but as a developer we will try our best to abstract away database concept (from frontend) as much as possible by seperating database functainality in a seperate module. and frontend will just call as simple as method like savePassword() or loadPassword() and something along that lines. to communicate with db.
+
+> [!NOTE]
+> Database schema versioning system is completely serperte from the app versioning system.
+
+**Database**: Sqlite3(`master.db`), Jsonfile(`sys.db`)
+
+## sys.db
+sys.db is system db in json file where we store all the important data specfic to app and this data is usefull, during the schema updation process. this info is use by app updation module to change db schema when jump from one version to another.
+
+> [!IMPORTANT]
+> System database schema must not be alter between the app version.
+> It allowed to add data but, not allowed to remove existing as different version of app rely on same data for there effective operation.
+
+```json
+{
+  "app-name": "password-manager",
+  "app-version": "v0.0.0-Alpha",
+  "db-schema-version": "v1",
+  "installed-at": "dd/mm/yy",
+  "update-at": [
+    {
+      "from": "v0.0.0-alpha",
+      "to": "v0.1.0-Alpha",
+      "on": "dd/mm/yy"
+    }
+  ],
+  "app-setting": {
+    "extensive-mode": false,
+    "prefer-dark-mode": true,
+    "external-db": {
+      "uri": "postgresql://username:password@host:port/dbname[?paramspec]",
+      "server": "postgresql"
+      ....
+    }
+  }
+  ....
+}
+```
+
+## master.db
+
+It is a database where user info is stored. It schema changes often between the app version based on change in business requirements. Here, in this section you will find all the version of database schema & will also find info on how we adopated to the new schema. 
+
+---
+
+### In Future (v2)
+
+| Tables      | Description                  |
+| ----------- | ---------------------------- |
+| `users`     | For storing user entity.     |
+| `passwords` | For storing password entity. |
+
+#### users table
+
+| Fields      | Property    | Constraints                    | Description                                                |
+| ----------- | ----------- | ------------------------------ | ---------------------------------------------------------- |
+| `id`        | Number      | PRIMARY KEY                    | --                                                         |
+| `username`  | VarChar(40) | NOT NULL                       | domain name to which password enitity is associated with   |
+| `password`  | VarChar(60) | NOT NULL                       | username on that domain. email can be also used as a value |
+| `type`      | VarChar(60) | Enum['sys', 'admin', 'normal'] | password on that domain                                    |
+| `createdat` | Date        | --                             | --                                                         |
+
+#### passwords table
+
+| Fields      | Property    | Constraints        | Description                                                |
+| ----------- | ----------- | ------------------ | ---------------------------------------------------------- |
+| `id`        | Number      | PRIMARY KEY        | --                                                         |
+| `domain`    | VarChar(40) | NOT NULL           | domain name to which password enitity is associated with   |
+| `username`  | VarChar(60) | NOT NULL           | username on that domain. email can be also used as a value |
+| `password`  | VarChar(60) | NOT NULL           | password on that domain                                    |
+| `createdat` | Date        | --                 | --                                                         |
+| `updatedat` | Date        | --                 | --                                                         |
+| `ownby`     | users(id)   | FORIGN KEY         | --                                                         |
+
+#### Implementation.
+create a defualt user called (101, "passcoder", "qwerty", "sys", "05/08/24") and make all passwords as own by him.
+
+---
+
+### Current Database Design (v1)
+
+| Tables      | Description                  |
+| ----------- | ---------------------------- |
+| `passwords` | For storing password entity. |
+
+#### passwords table
+
+| Fields      | Property    | Constraints        | Description                                                |
+| ----------- | ----------- | ------------------ | ---------------------------------------------------------- |
+| `id`        | Number      | PRIMARY KEY        | --                                                         |
+| `domain`    | VarChar(40) | NOT NULL           | domain name to which password enitity is associated with   |
+| `username`  | VarChar(60) | NOT NULL           | username on that domain. email can be also used as a value |
+| `password`  | VarChar(60) | NOT NULL           | password on that domain                                    |
+| `createdat` | Date        | --                 | --                                                         |
+| `updatedat` | Date        | --                 | --                                                         |

docs/release-workflow.md

@@ -0,0 +1,17 @@
+# Release Workflow
+
+In this file you will find documented process about how we release new version of a app.
+
+1. We follow so called `Main as Production Environment`. So, during the time of release we test the main branch code.
+
+2. Updated the Code where ever need. (code that refer to previous version).
+
+3. Make Documentation up-to-date. (document the main change in app from user point of view).
+
+4. Update `changelog.md`
+
+5. Draft a Release with all apk file uploaded (signed apks).
+
+6. Discuss on telegram community and check release app on various parameters and
+
+7. Then release it.