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

   git clone https://github.com/Pan14ek/english-cards.git
   cd english-cards

2. Configure the database configuration

   Open the src/main/resources/application.properties file and fill required fields to work with DB locally.

   spring.datasource.url=
   spring.datasource.username=
   spring.datasource.password=

   Hint

   You can run PostgreSQL using Docker:

   docker run --name some-postgres -e POSTGRES_PASSWORD=ju23pass -p 5432:5432 -d postgres

3. Build the project

   ./gradlew clean build 

4. Run the application

   1. Open the src/main/java/EnglishCardsApplication.java file
   2. Run the main method.

5. Enjoy :)