Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucasstarsz/fxdex
https://github.com/lucasstarsz/fxdex
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lucasstarsz/fxdex
- Owner: lucasstarsz
- License: apache-2.0
- Created: 2024-07-23T18:38:12.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-03T01:52:08.000Z (3 months ago)
- Last Synced: 2024-08-03T03:17:18.336Z (3 months ago)
- Language: Java
- Size: 1.44 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# FXDex
FXDex is a project designed for easy access to information about Pokémon as they appear throughout the many mainstream
Pokémon games.
> [!WARNING]
> This project is still **in heavy development.** Features can and will change at any time, until a versioning cycle is
> defined.
## How to Run
This project can be downloaded and run in a few steps from your command line, provided you
have [Git](https://git-scm.com/downloads) installed, or another way to clone the project.
You may either download the [latest release](https://github.com/lucasstarsz/fxdex/releases), or use the below commands
to download the project files and run it from those.
```bash
# 1. Clone repository
git clone https://github.com/lucasstarsz/fxdex.git
# 2. Enter 'fxdex' folder
cd fxdex
# Run project from the 'gradlew' file (or gradlew.bat file for Windows users)
gradlew run
```
If you want to create an executable:
```bash
gradlew jpackage
```
> [!NOTE]
> You can generate an installer for the application by changing `skipInstaller` from `false` to `true`, inside
> the `jlink/jpacakge` task.
## Dependencies
- [PokéAPI](https://pokeapi.co) for all details on Pokémon.
- [JSON in Java](https://github.com/stleary/JSON-java)
- [Google Guice](https://github.com/google/guice)
- [Jakarta-Inject](https://github.com/jakartaee/inject)
- [Apache Commons-Lang](https://github.com/apache/commons-lang) & [Apache Commons Text](https://github.com/apache/commons-text)
- [atlantafx](https://github.com/mkpaz/atlantafx) for UI Theming
- [Badass JLink Plugin](https://github.com/beryx/badass-jlink-plugin) for distribution.
## License
This project is licensed under the [Apache Commons 2.0 License](LICENSE.md).