Platform for English words learning.
To run this app you need Node.js 8+ and npm 4+ and PostgreSQL database
- Create environment variables:
CLOUDINARY_API_KEY
andCLOUDINARY_API_SECRET
with your cloudinary api-key and api-secret - To build and start the project run
docker-compose up --build -d
script
You can populate database with your own words set or use word scrapper.
To user word scrapper:
- enable the onion routing proxy - TOR proxy (needed to prevent rate limiting)
- run
npm start --prefix scrapper
- it will save all fetched words in
scrapper/data/words.json
. - Then you should write sequelize-seeder to insert result into the database
- add seeder file into
back/database/seeders
- and run
npm run db:seed:all
- to apply changes
For 20k words it will took approximately 120 minutes
- words learning is based on an association with images
- and organized in interactive chat-based competition
- also, users can track their progress
Word-Kombat is released under the BSD-3 License.