Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Alok-2002 committed Jun 6, 2023
1 parent c415ef0 commit 6dddc89
Showing 1 changed file with 84 additions and 0 deletions.
84 changes: 84 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
## Code Vault - Android App

Code Vault is an Android application developed using Android Studio that provides encryption and decryption of text using the Base64 algorithm and a secret key.
This app allows users to securely store and share sensitive information by encoding it into Base64 format with a secret key.
![image](https://github.com/Alok-2002/Code_Vault_Android_App/assets/93814546/5ab9c02d-9402-43a8-b8b3-e96378cdcbc2)


## Features

- Text encryption: Encrypt any text using the Base64 algorithm and a secret key.
- Text decryption: Decrypt Base64-encoded text using the secret key.
- Secure storage: Store encrypted text securely within the app.
- Share encrypted text: Share the encrypted text with others via various communication channels.
- Clean and intuitive user interface.

## Installation

To use the Code Vault app, follow these steps:

1. Clone the repository to your local machine:

```
git clone https://github.com/alok-2002/code_vault_android_app.git
```

2. Open the project in Android Studio.

3. Build and run the app on an Android device or emulator.

## Usage

1. Launch the Code Vault app on your Android device.

2. Enter the secret key "1234" in the provided input field. (Note: For security reasons, it is recommended to use a strong and unique secret key.)

3. Enter the text you want to encrypt in the provided input field.

4. Tap the "Encrypt" button to encrypt the text using the Base64 algorithm and the secret key.

5. The encrypted text will be displayed in the output field.

6. To decrypt the text, enter the encrypted text in the input field.

7. Tap the "Decrypt" button to decrypt the text using the secret key.

8. The decrypted text will be displayed in the output field.

9. You can store the encrypted text within the app by tapping the "Save" button.

10. To share the encrypted text, tap the "Share" button and choose the desired communication channel.

## Contributing

Contributions to the Code Vault app are welcome! If you would like to contribute, please follow these steps:

1. Fork the repository.

2. Create a new branch for your feature or bug fix.

3. Make your changes and commit them.

4. Push your changes to your fork.

5. Submit a pull request to the main repository.

Please ensure that your contributions adhere to the coding standards and guidelines used in the project.

## License

The Code Vault app is open-source and released under the [MIT License](LICENSE).

## Acknowledgments

This app was developed with the help of the following resources:

- Android Studio: The official Integrated Development Environment (IDE) for Android app development.
- Base64 Encoding/Decoding: The Base64 algorithm used for text encryption and decryption.
- Android Documentation: Official documentation and tutorials provided by the Android team.

## Contact

If you have any questions, suggestions, or issues, please contact [your-name] at [your-email].

Happy encrypting and decrypting with Code Vault!

0 comments on commit 6dddc89

Please sign in to comment.