Skip to content

Commit fa4eebe

Browse files
committed
add README files
1 parent 352a6f8 commit fa4eebe

2 files changed

Lines changed: 96 additions & 0 deletions

File tree

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# JavaGameBox
2+
3+
JavaGameBox is a simple game platform that allows users to play classic games. It includes features like user authentication, score tracking, and a leaderboard system.
4+
5+
## Project Structure
6+
7+
The project is organized as follows:
8+
- `src/main/java/ru/ivannovr`: Contains the main application code.
9+
- `games`: Logic for individual games.
10+
- `gui`: Graphical user interface components.
11+
- `utils`: Utility classes, including database management.
12+
- `src/main/resources`: Contains resources like icons and configuration files.
13+
- `pom.xml`: Maven configuration file for dependency management and project building.
14+
15+
## Building the Project
16+
17+
To build the project, you need to have Maven installed. You can download Maven from the [official website](https://maven.apache.org/download.cgi).
18+
19+
Once Maven is installed, navigate to the project root directory and run:
20+
21+
```mvn clean package```
22+
23+
This command compiles the code, runs tests, and packages the application into a JAR file located in the `target` directory.
24+
25+
## Running the Project
26+
27+
To run the project, you need Java installed. You can download Java from the [official website](https://www.java.com/en/download/).
28+
29+
Additionally, the project requires PostgreSQL to be installed and running. You can download PostgreSQL from the [official website](https://www.postgresql.org/download/).
30+
31+
Before launching the application, set up the database:
32+
1. Create a new database in PostgreSQL.
33+
2. Update the database URL, username, and password in the command-line arguments when running the JAR file.
34+
35+
Run the application with the following command:
36+
37+
```java -jar target/JavaGameBox-1.0.jar --db-url=<database_url> --db-user=<database_user> --db-password=<database_password>```
38+
39+
Replace `<database_url>`, `<database_user>`, and `<database_password>` with your actual PostgreSQL connection details.
40+
41+
## Additional Information
42+
43+
- The project uses Maven for dependency management (see `pom.xml` for details).
44+
- Logging is handled by Log4j, with configuration defined in `src/main/resources/log4j2.xml`.
45+
- The GUI is built using Swing.
46+
- Each game is implemented using object-oriented principles, extending an `AbstractGame` class.
47+
48+
For more details, refer to the source code and comments.

README_RU.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# JavaGameBox
2+
3+
JavaGameBox — это простая игровая платформа, которая позволяет пользователям играть в классические игры. Платформа поддерживает аутентификацию пользователей, отслеживание очков и систему лидеров.
4+
5+
## Структура проекта
6+
7+
Проект организован следующим образом:
8+
- `src/main/java/ru/ivannovr`: Содержит основной код приложения.
9+
- `games`: Логика для каждой игры.
10+
- `gui`: Компоненты графического интерфейса.
11+
- `utils`: Утилитарные классы, включая управление базой данных.
12+
- `src/main/resources`: Содержит ресурсы, такие как иконки и файлы конфигурации.
13+
- `pom.xml`: Файл конфигурации Maven для управления зависимостями и сборки проекта.
14+
15+
## Сборка проекта
16+
17+
Для сборки проекта необходимо установить Maven. Скачать Maven можно с [официального сайта](https://maven.apache.org/download.cgi).
18+
19+
После установки Maven перейдите в корневую директорию проекта и выполните:
20+
21+
```mvn clean package```
22+
23+
Эта команда скомпилирует код, запустит тесты и упакует приложение в JAR-файл, который будет находиться в директории `target`.
24+
25+
## Запуск проекта
26+
27+
Для запуска проекта требуется установленная Java. Скачать Java можно с [официального сайта](https://www.java.com/en/download/).
28+
29+
Также необходимо установить и запустить PostgreSQL. Скачать PostgreSQL можно с [официального сайта](https://www.postgresql.org/download/).
30+
31+
Перед запуском приложения настройте базу данных:
32+
1. Создайте новую базу данных в PostgreSQL.
33+
2. Укажите URL базы данных, имя пользователя и пароль в аргументах командной строки при запуске JAR-файла.
34+
35+
Запустите приложение с помощью команды:
36+
37+
```java -jar target/JavaGameBox-1.0.jar --db-url=<database_url> --db-user=<database_user> --db-password=<database_password>```
38+
39+
Замените `<database_url>`, `<database_user>` и `<database_password>` на ваши реальные данные для подключения к PostgreSQL.
40+
41+
## Дополнительная информация
42+
43+
- Проект использует Maven для управления зависимостями (подробности в `pom.xml`).
44+
- Логирование реализовано через Log4j, конфигурация находится в `src/main/resources/log4j2.xml`.
45+
- Графический интерфейс построен с использованием Swing.
46+
- Игры реализованы с применением объектно-ориентированных принципов, каждая игра наследуется от класса `AbstractGame`.
47+
48+
Для дополнительной информации обратитесь к исходному коду и комментариям.

0 commit comments

Comments
 (0)