-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
32 changed files
with
37 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,16 +16,16 @@ gradlew lint | |
### 1. Explore | ||
* Run the app, find issues and raise one in github | ||
* **OR** see the issues section in github, leave a comment on a issue on which you want to work. If no one is working on it then it will be assigned to you and you can start to work on it. | ||
<img src="./screenshots/section_issue.png" width="190px"> | ||
<img src="./screenshots/contributing/section_issue.png" width="190px"> | ||
|
||
### 2. Fork the repository | ||
|
||
<img src="./screenshots/fork.png" width="190px"> | ||
<img src="./screenshots/contributing/fork.png" width="190px"> | ||
|
||
### 3. Create a new branch | ||
* From android studio | ||
|
||
<img src="./screenshots/create_new_branch.png"> | ||
<img src="./screenshots/contributing/create_new_branch.png"> | ||
* **OR** From command line | ||
|
||
`git checkout -b feature/add-new-login-data` | ||
|
@@ -35,7 +35,7 @@ IMPORTANT : Follow this naming convention for new branch names : `feature/nameOf | |
### 4. Run the project locally and test your changes on emulator/Real device. Feel free to ask for help on slack. Everyone is beginner at first. | ||
|
||
### 5. Run `gradlew lint` in Android studio integrated terminal.As shown below the command will be automatically highlighted in Yellow, after this press `ctrl+enter`. You can find report at this location `app/build/reports/lint-results.html`. If you see a new error/warning because of your code, make sure you fix it before making a PR. | ||
<img src="./screenshots/running_terminal_command.png"> | ||
<img src="./screenshots/contributing/running_terminal_command.png"> | ||
|
||
### 6. Before you push your changes, make sure you merge latest master changes in your feature branch. | ||
``` | ||
|
@@ -57,7 +57,7 @@ git commit -m'a descriptive message here' | |
``` | ||
* (Recommended way) In case you are committing from Android studio (`ctrl+K`) then make sure to select these below options and in the Author box enter in this format only : `name <email>`. eg: `Nitin Verma <[email protected]>` | ||
|
||
<img src="./screenshots/commit_from_android_studio.png"> | ||
<img src="./screenshots/contributing/commit_from_android_studio.png"> | ||
On commit detekt and ktlint will run automatically to verify code quality. | ||
|
||
### 8. Solve detekt, ktlint errors | ||
|
@@ -67,30 +67,30 @@ app/build/reports/detekt/detekt.html | |
app/build/reports/ktlint/ktlintMainSourceSetCheck/ktlintMainSourceSetCheck.txt | ||
``` | ||
INFO : For ktlint, errors can also be found in the terminal. | ||
|
||
INFO : Incase Detekt fails, then report will automatically open in browser | ||
NOTE : until ktlint and detekt issues are fixed, you will not be able to commit your changes. | ||
|
||
Once commit is done, push your changes. | ||
|
||
### 9. Create Pull Request | ||
Open the forked repo in browser. You should see an option to create pull request. | ||
|
||
<img src="./screenshots/pull_request_button.png"> | ||
<img src="./screenshots/contributing/pull_request_button.png"> | ||
|
||
Then in this dialog verify that: | ||
* base is master. | ||
* compare is your new branch. | ||
* Able to merge is green tick. | ||
* Fill data required in description box. | ||
|
||
<img src="./screenshots/create_pull_request.png"> | ||
<img src="./screenshots/contributing/create_pull_request.png"> | ||
|
||
After create pull request, wait for all the checks to pass | ||
|
||
<img src="./screenshots/pull_req_checks.png"> | ||
<img src="./screenshots/contributing/pull_req_checks.png"> | ||
|
||
You can also track progress in actions tab. Click on the workflow to see which steps have executed or have error. If you scroll to the bottom of a workflow then you can also see the reports. Download and verify the reports. | ||
|
||
<img src="./screenshots/workflow.png"> | ||
<img src="./screenshots/contributing/workflow.png"> | ||
|
||
### 10. Wait for someone to review your code and merge changes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,43 +8,43 @@ Safe Box is an easy to use, secure app which will store all your data in a super | |
<img src="./screenshots/get it on google play store.jpg" width="40%"> | ||
</a> | ||
|
||
</br> | ||
|
||
## Features | ||
* Login with master password or biometric (fingerprint/IRIS/Face) | ||
* Add different kind of personal data and Easy navigation | ||
* Store data locally and encrypted | ||
* Supports dark theme | ||
* Share non-confidential data from a record with a single click | ||
|
||
<hr> | ||
|
||
<img src="./screenshots/readme/signup.png" height="400px" width = "200px"/>  | ||
<img src="./screenshots/readme/login.png" height="400px" width = "200px"/>  | ||
<img src="./screenshots/readme/addNewData.png" height="400px" width = "200px"/> | ||
</br></br> | ||
|
||
<img src="./screenshots/readme/onePlace.png" height="400px" width = "200px"/>  | ||
<img src="./screenshots/readme/swipeToDelete.png" height="400px" width = "200px"/>  | ||
<img src="./screenshots/readme/editCopyShareDelete.png" height="400px" width = "200px"/> | ||
|
||
<hr> | ||
|
||
## Contributing to this project | ||
Want to contribute to Safe Box? Please read [Contribution process](https://github.com/Ni3verma/Safe-Box/blob/master/CONTRIBUTING.md). In case you have any questions, feel free to reach me on [email protected] | ||
|
||
<hr> | ||
|
||
## Connect with me on | ||
|
||
<a href="https://join.slack.com/t/safe-box-workspace/shared_invite/zt-yatwfl44-uu3BgU3JohO2RQSuOuY3xA"> | ||
<img src="./screenshots/slack.png" width="30%"> | ||
<img src="./screenshots/connectWithMe/slack.png" width="30%"> | ||
</a>   | ||
<a href="https://www.linkedin.com/in/nitinverma1120/"> | ||
<img src="./screenshots/linked in.png" width="30%"> | ||
<img src="./screenshots/connectWithMe/linked in.png" width="30%"> | ||
</a>   | ||
<a href="https://nitin-code.medium.com/"> | ||
<img src="./screenshots/medium.png" width="30%"> | ||
<img src="./screenshots/connectWithMe/medium.png" width="30%"> | ||
</a> | ||
|
||
<br><br><hr> | ||
|
||
<img src="./screenshots/signup with error.png" height="400px" width = "200px"/> . . . . | ||
<img src="./screenshots/signup.png" height="400px" width = "200px"/> . . . . | ||
<img src="./screenshots/login.png" height="400px" width = "200px"/> | ||
|
||
<br> | ||
|
||
## Everything is stored only **locally** and **encrypted** | ||
|
||
<img src="./screenshots/encrypted db.png" /> | ||
|
||
<br> | ||
|
||
## Add different kind of personal data | ||
|
||
Login Data| Bank Account Data| Bank Card Data| Secure Note Data | ||
--- | --- | --- | --- | ||
<img src="./screenshots/login data.png" height="400px" width = "200px"/> | <img src="./screenshots/bank account data.png" height="400px" width = "200px"/> | <img src="./screenshots/bank card data.png" height="400px" width = "200px"/> | <img src="./screenshots/secure note data.png" height="400px" width = "200px"/> | ||
|
||
<br> | ||
|
||
Easy navigation | Add new data | Everything in one place | Delete on swipe | ||
--- | --- | --- | --- | ||
<img src="./screenshots/side drawer.png" height="400px" width = "200px"/> | <img src="./screenshots/add new data options.png" height="400px" width = "200px"/> | <img src="./screenshots/all info.png" height="400px" width = "200px"/> | <img src="./screenshots/swipe to delete.png" height="400px" width = "200px"/> |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.