https://github.com/k1ethoang/be_learn-vocabulary_kdp

Backend of a website helps everyone to learn vocabulary
https://github.com/k1ethoang/be_learn-vocabulary_kdp

Last synced: 11 days ago
JSON representation

Backend of a website helps everyone to learn vocabulary

• Host: GitHub
• URL: https://github.com/k1ethoang/be_learn-vocabulary_kdp
• Owner: K1ethoang
• Created: 2024-10-08T15:20:44.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-12-22T10:53:36.000Z (20 days ago)
• Last Synced: 2024-12-22T11:27:56.706Z (20 days ago)
• Language: Java
• Size: 138 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Learn Vocabulary KDP Service

# Features

# Set up

## Requirement

- JDK 17+ ([How to download](https://www.geeksforgeeks.org/download-and-install-java-development-kit-jdk-on-windows-mac-and-linux/))

- IDE: [IntelliJ IDEA

  ](https://www.jetbrains.com/idea/) (Optional)

- [Lombok](https://projectlombok.org/): Install plugin in your IDE or Text Editor. [How to install Lombok](https://www.google.com/search?q=how+to+install+lombok)

- MySQL (Use with Docker)

### 1. Clone this repository

```git

https://github.com/K1ethoang/BE_Learn-Vocabulary_KDP.git

```

### 2. Go to project folder

```git

cd BE_Learn-Vocabulary_KDP

```

## .ENV

- Has 2 `.env` file: [.env.example](.env.example) for you set up with your configuration and [.env.dev](.env.dev) to run if you do not care about configuration.

## Install Docker (Required)

- Follow-up [document of Docker](https://docs.docker.com/compose/install/)

## How to run

### [Run manually Wiki](https://github.com/K1ethoang/BE_Learn-Vocabulary_KDP/wiki/Run-manually)

### [Run with Docker Wiki](https://github.com/K1ethoang/BE_Learn-Vocabulary_KDP/wiki/Run-with-Docker)

# Usage (Building)

Access http://localhost:9091/swagger-ui/index.html to see Api document, read more [Usage wiki]()