Skip to content

Latest commit

 

History

History
105 lines (67 loc) · 2.27 KB

README.md

File metadata and controls

105 lines (67 loc) · 2.27 KB

mei-tian

A React-Flask-based Chinese-English dictionary app! (Additional functionality still in progress!)

View live on heroku: mei-tian.herokuapp.com/

About

Features:

  • Lookup of Chinese words with definitions and sample sentences
  • Displays random Chinese word on loading homepage
  • HSK 2.0 and HSK 3.0 word lists
  • Simplified / traditional character view toggle
  • Local history of user's word lookups

Technologies:

This app uses React and Material-UI for the front-end; Python web framework Flask for the back-end, served by a Gunicorn web server; deployed on Heroku.

Utilizes python package chinese-english-lookup created for this project to look up Chinese-English definitions.

Sources:

  • Chinese-English definitions from CC-CEDICT
  • Sample Chinese sentences from jukuu

Running locally

Build front-end:

npm run build

Run eslint, sort imports:

npm run lint

Start local gunicorn web server:

heroku local -f Procfile.dev

Deployment setup

See heroku docs for more info.

Add buildpacks:

heroku buildpacks:set heroku/python
heroku buildpacks:set heroku/nodejs

Note: The python buildpack should be added first.

This can also be done through heroku app settings.

Add web dyno:

Create Procfile with web process to start gunicorn:

web: gunicorn --chdir flaskr "app:create_app()"

Scale app dyno (1 web process); docs on dynos:

heroku ps:scale web=1

List dynos:

heroku ps

=== web (Free): gunicorn --chdir flaskr "app:create_app()" (1)
web.1: idle 2021/03/26 08:02:40 +0000 (~ 9m ago)

Add requirements.txt:

touch requirements.txt
pip freeze > requirements.txt

(Can remove unnecessary dependencies.) This file should be updated when new dependencies are added.

Deploying:

git push heroku master

License

MIT