https://github.com/spyder01/charlotte
Folder encryption and decryption tool built with Scala
https://github.com/spyder01/charlotte
cli cryptography encryption fileencryption scala software-engineering
Last synced: 3 months ago
JSON representation
Folder encryption and decryption tool built with Scala
- Host: GitHub
- URL: https://github.com/spyder01/charlotte
- Owner: Spyder01
- License: mit
- Created: 2023-06-27T03:14:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-03T10:01:08.000Z (almost 2 years ago)
- Last Synced: 2025-02-12T05:42:13.368Z (5 months ago)
- Topics: cli, cryptography, encryption, fileencryption, scala, software-engineering
- Language: Scala
- Homepage:
- Size: 199 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
Charlotte
An awesome Scala based tool to encrypt your files.
Explore the docs »
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
Charlotte is an easy-to-use command-line tool to encrypt your files.
Why Use:
* It's easy to use and minimalistic hence you are not crowded by myriad of unwanted features.
* It's safe and secure.
### Built With
* [![Scala][Scala]][Scala-url]
## Getting Started
### Prerequisites
* Make sure git is installed in your system.
* Make sure you have jdk installed.
* Make sure you have Scala and sbt.
### Installation
_Below is how you can install repository on your system._
1. Clone the repo
```sh
git clone https://github.com/SuhanBangera/Charlotte
```
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
_For more examples, please refer to the [Documentation](https://github.com/SuhanBangera/Charlotte)_
## Roadmap
- [x] Add Basic Functionality.
- [x] Add support for encrypting folders.
- [x] Add support for encrypting individual files.
- [x] Resolve the access issues for internal directories.
- [x] Implement more secure encryption method.
- [ ] Utilize multithreading for better performance.
See the [open issues](https://github.com/SuhanBangera/Charlotte/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Suhan Bangera - [@](https://www.linkedin.com/in/suhan004/)Suhan
Project Link: [https://github.com/SuhanBangera/Charlotte](https://github.com/SuhanBangera/Charlotte)
## Acknowledgments
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
* [Choose an Open Source License](https://choosealicense.com)
* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
* [Scala](https://www.scala-lang.org/)
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/SuhanBangera/Charlotte/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
[forks-url]: https://github.com/SuhanBangera/Charlotte/network/members
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
[stars-url]: https://github.com/SuhanBangera/Charlotte/stargazers
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
[issues-url]: https://github.com/SuhanBangera/Charlotte/issues
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
[license-url]: https://github.com/SuhanBangera/Charlotte/blob/main/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/suhan004/
[product-screenshot]: images/screenshot.png
[Scala]: https://img.shields.io/badge/scala-000000?style=for-the-badge&logo=scala&logoColor=red
[Scala-url]: https://www.scala-lang.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com