Skip to content

devcocup/word-kombat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Word Kombat

word-kombat

Platform for English words learning.


Build and Run

To run this app you need Node.js 8+ and npm 4+ and PostgreSQL database

  1. Create environment variables: CLOUDINARY_API_KEY and CLOUDINARY_API_SECRET with your cloudinary api-key and api-secret
  2. To build and start the project run docker-compose up --build -d script

Words scrapping

You can populate database with your own words set or use word scrapper.

To user word scrapper:

  1. enable the onion routing proxy - TOR proxy (needed to prevent rate limiting)
  2. run npm start --prefix scrapper
  3. it will save all fetched words in scrapper/data/words.json.
  4. Then you should write sequelize-seeder to insert result into the database
  5. add seeder file into back/database/seeders
  6. and run npm run db:seed:all - to apply changes

For 20k words it will took approximately 120 minutes

Main features

  • words learning is based on an association with images
  • and organized in interactive chat-based competition
  • also, users can track their progress

UI samples

Sign Up

signup

Chat (Words Learning)

chat

The end of a match

match-end

Account

account

Leaderboards

leaderboards

On mobile screens

mobile

Chat offline

chat-offline

Account offline

account-offline

License

Word-Kombat is released under the BSD-3 License.

About

English words learning platform

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published