Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kutay-celebi/sentency

Learn English in sentences
https://github.com/kutay-celebi/sentency

english-language english-learning google quarkus vite vue

Last synced: about 1 month ago
JSON representation

Learn English in sentences

Awesome Lists containing this project

README 

        









Sentency




# Introduction



This repository is built by combining multiple external APIs. Basically, it aims to teach English words to users by

creating sentences. Lingua Robot is used for the definitions of the words and Google Translate API is used to translate

the user's sentences with that word. The reviewing algorithm has not been designed yet, and it is done with simple date

checks. The learning process of a word is as follows:



- Search for the word

- Add the word to the learning list

- Make a sentence with the word

- Select the difficulty of the word

- Regularly review the words in the list



# Roadmap



In the future, the application will be made to run on AWS cloud systems with native image. The learning algorithm will

be improved and users will be able to use different materials (image, gif, video and so on.) while learning. At the

moment, it is only designed for mobile browsers, but web browser and mobile native application development will also be

done.



# Prerequisites



1. JDK 11

2. Gradle

3. Node > v16

4. Docker



# Setup



## Preparation



1. [Creating google service account](#creating-google-service-account).

2. [Creating google OAuth Credentials](#creating-google-oauth-client).

3. [Subscribing WordsAPI on RapidAPI](#subscribe-words-api-on-rapidapi).



# Local Development



## Overview of Environment Variables



| Variable                       | Description                                                                                                    |

|--------------------------------|----------------------------------------------------------------------------------------------------------------|

| DATABASE_DB-KIND               | Database type. [See also.](https://quarkus.io/guides/all-config#quarkus-datasource_quarkus.datasource.db-kind) |

| DATABASE_USERNAME              | Database username                                                                                              |

| DATABASE_PASSWORD              | Database password                                                                                              |

| DATABASE_URL                   | Database vertx url. [See also.](https://quarkus.io/guides/hibernate-reactive#hr-getting-started)               |

| GOOGLE_PROJECT-ID              | Google project id                                                                                              |

| GOOGLE_APPLICATION_CREDENTIALS | Google service accounts credential file path. [See also](#creating-google-service-account)                     |

| GOOGLE_CLIENT-ID               | For google login. [See also](#creating-google-oauth-client)                                                    |

| LR_RAPID_API_URI               | Rapid api base uri. [See Also](#subscribe-lingua-robot-api-on-rapidapi)                                        |

| LR_RAPID_API_HOST              | Rapid api host. [See Also](#subscribe-lingua-robot-api-on-rapidapi)                                            |

| LR_RAPID_API_KEY               | Rapid api key. [See Also](#subscribe-lingua-robot-api-on-rapidapi)                                             |



## Creating Google Service Account



1. Open [Google Console](https://console.cloud.google.com)

2. Create Project.

3. Enable [Cloud Translation API](https://console.cloud.google.com/apis/library/translate.googleapis.com) for project.

4. Create service account.

5. Add `Cloud Translation API User` permission to service account for using Google Cloud Translation Api

6. Create service account key. Copy downloaded json file to project path.

7. Give the absolute path of this json file to `GOOGLE_APPLICICATION_CREDENTIALS` as an environment variable.



## Creating Google OAuth Client



1. Go to [https://console.cloud.google.com/apis/credentials?project=PROJECT_NAME](#creating-google-oauth-client)

2. Create OAuth Client ID.

3. Adjust OAuth consent screen.

4. Adjust client ID to `GOOGLE_CLIENT-ID` as an environment variable.



## Subscribe Lingua Robot API on RapidApi



1. Go to [Lingua Robot](https://rapidapi.com/rokish/api/lingua-robot)

2. Subscribe API.

3. Set host and key as environment variables.