Add readme

README.md

@@ -0,0 +1,62 @@
+# English cards
+
+<img src="./img/logo.png" alt="English Cards">
+
+# Idea
+
+Many people try to learn and remember new English words but forget about them too fast. This application aims to help
+people use a deck of cards on different topics. This can be a custom deck that users created or generated by AI on
+specific topics. Users will have the ability to use
+interval repetition to recall learnt words.
+
+# Application part
+
+This repository is responsible for the main backend part that will include main items for the system.
+
+### Requirements
+
+- **Java**: Version 17.
+- **Gradle**
+- **Docker**
+- **PostgreSQL**
+
+### Getting Started
+
+Follow these steps to get started with the project:
+
+1. **Clone this repository**
+
+    ```bash
+   git clone https://github.com/Pan14ek/english-cards.git
+   cd english-cards
+   ```
+
+2. **Configure the database configuration**
+   <p>Open the <b>src/main/resources/application.properties</b> file and fill required fields to work with DB locally.</p>
+
+   ```properties
+   spring.datasource.url=
+   spring.datasource.username=
+   spring.datasource.password=
+   ```
+
+   **Hint**
+   <p>You can run PostgreSQL using Docker:
+
+   ```bash
+   docker run --name some-postgres -e POSTGRES_PASSWORD=ju23pass -p 5432:5432 -d postgres
+   ```
+
+
+3. **Build the project**
+
+    ```bash
+   ./gradlew clean build 
+   ```
+
+4. **Run the application**
+
+    1. Open the <b>src/main/java/EnglishCardsApplication.java</b> file
+    2. Run the main method.
+
+5. **Enjoy :)**