Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 1.86 KB

DEVELOPMENT_MANUAL.md

File metadata and controls

28 lines (23 loc) · 1.86 KB

Requirements

  • Java 8 (for development), to use the app normally you can download it from Here ⬇️

  • Maven 3.3+

  • Scene Builder: is a visual layout tool for designing JavaFX user interfaces without writing FXML code manually.

    Make sure to download version 8.5.0, to be compatible with Java 8
    Also its required to import the UI libraries used in Scene Builder if you gonna use it

Installation for development

  1. Download the repository files (project) from the download section or clone this project by typing in the bash the following command:

    git clone https://github.com/AbdelrahmanBayoumi/Azkar-App.git

  2. Import it in Intellij IDEA or any other Java IDE and let Maven download the required dependencies for you.

  3. To use Sentry (for error reporting) you need to add your own DSN in the src/main/resources/sentry.properties file.

    • See sentry.properties.example for an example.

  4. To use the ip2location location services, you need to add your ip2location.apiKey in the src/main/resources/config.properties file.

    • See config.properties.example for an example.

  5. Run the application 😁