Skip to content

JavaPad is a simple and user-friendly text editor written in Java.

License

Notifications You must be signed in to change notification settings

dfortch18/javapad

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JavaPad

JavaPad is a simple and user-friendly text editor written in Java. It includes essential features such as file operations, undo/redo actions, theme customization, and multilingual support.

Features

  • Open, Save, and Create Files: Easily manage your text files.
  • Undo, Redo, Cut, Copy, Paste: Full support for text editing operations.
  • Light and Dark Themes: Choose between light, dark, and native themes to suit your preferences.
  • Editor Customization: Personalize the appearance and behavior of the editor.
  • Multilingual Support: Available in English, Spanish and French.

Installation and use

  1. Clone the repository
    git clone https://github.com/dfortch18/javapad.git
  2. Navigate to the directory
    cd javapad
  3. Build the project using Maven
    mvn clean install

Usage

To run JavaPad, use the following command after building the project:

java -jar target/javapad-1.1.jar

Development

Prerequisites

  • Java 21 or higher
  • Maven 3.6 or higher

Building the project

To build the project, run:

mvn clean install

Running Tests

To execute tests, run:

mvn test

Code coverage

Code coverage reports can be generated using Jacoco. To generate the report, run:

mvn test jacoco:report

The report will be available at target/site/jacoco/index.html.

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes. Ensure that you adhere to the project's coding standards and include appropriate tests for your contributions.

  1. Fork the repository.
  2. Create a feature branch (git checkout -b feature/your-feature).
  3. Commit your changes (git commit -m 'Add some feature').
  4. Push to the branch (git push origin feature/your-feature).
  5. Create a new Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgements

  • FlatLaf for the sleek look and feel.
  • Log4j for logging.
  • AssertJ for fluent assertions in testing.
  • JUnit 5 for the testing framework.
  • Mockito for mocking in tests.
  • Weld SE for the CDI implementation.