Hi, Welcome to leetEnglish, LeetEnglish is an app that allows users to increase their vocabulary level by reading. In this app, you will be able to read articles shared by another user as public articles, you will be able to read through the entire content and get definitions as well as add an image to help your memorization of the vocabulary. Besides that, you will be able to import your own article into the app, and you also able to implement the whole feature as public articles, get definitions, memorization vocabulary with images, and getting practice with the vocabulary.

Most importantly, In leetEnglish you will be able to connect with another user, adding your own tweets, share your moment with another user!, let diving in!

leetEngish use two APIs, WordsAPI and GoogleSeach API(serpapi)

WordsAPI: get the definition for the unknown vocabulary

GoogleSearch API: retrieve unknown vocabulary memorize images

if you would like to see more detail of my code, making sure to retrieve the API key for both APIs to prevent any unnecessary errors. on the root directly of the file create a file name "api_keys.py", under this file type of the following variable:

wordsapi = "your_api_key"
serpapi = "your_api_key" 

create databases in your computer call "leetenglish" and "leetenglish-test"

leetenglish for general storage and leetenglish-test for testing

CREATE DATABASE leetenglish

CREATE DATABASE leetenglish-test

for demonstration purpose to add data into the app, run seed.py file using ipython under the python virtual environment, runs the following commands

pip install -r requirements.txt

↓

source venv/bin/activate

↓

ipython

↓

%run seed.py

download the file from this repository, on your computer type the following command on your terminal:

source venv/bin/activate

under the virtual environment terminal type the following commands:

export FLASK_ENV=development

flask run

leetEnglish have 18 tables under leetenglish database:

• User
• Follows
• Quotes
• Articles
• Categories
• VocabularyFromArticle
• UserFinishReading
• VocabularyListName
• VocabularyList
• ImportCategory
• ImportArticles
• FinishImportReading
• ImportCategoryArticles
• VocabularyFromImportArticle
• Message
• CommentMessage
• Likes
• CommentLikes

leetEnglish! app has deployed on Heroku, you can either register an account or use my account to export the app

username: shuminzhou, password: shuminzhou