Giter Club home page Giter Club logo

tili20's Introduction

Tili 2.0 - Urban dictionary of kyrgyz

Instructions to run locally

Simple as that.

DB

  • words (word_id, word_text, created_at, author(user_id))
  • definitions(word(word_id), description_text, created_at, upvotes, downvotes)
  • users(user_id, nickname)

Steps to initiate:

  • flask db init
  • flask db stamp head
  • flask db migrate
  • flask db upgrade

How to run in debug mode

  1. Create a file launch.json in .vscode folder
{
  "python.condaPath": "/home/karakush/anaconda3",
  "version": "0.2.0",
  "configurations": [
  
      {
          "name": "Python: Remote Attach",
          "type": "python",
          "request": "attach",
          "connect": {
              "host": "localhost",
              "port": 5678
          },
          "pathMappings": [
              {
                  "localRoot": "path_to/tili20/web",
                  "remoteRoot": "."
              }
          ]
      }
  ]
}
  1. Run the docker-compose -f docker-compose-dev.yml up
  2. Attach to docker-compose in vscode begug

How to deploy

  1. Pull the code to server
  2. Install requiements.txt
  3. Assign environment variables in .flaskenv

Todo

There are many imporvements to make to this website. Feel free to send PRs and be a part of Neo-Kyrgyz movement.

  • Add admin panel for managing words
  • OAuth Google, Telegram
  • Add kygryz letters in word submission form
  • Refactor into blueprints
  • Parse the submitted definition to map to other words if they exist in db
  • Add sitemap for SEO
  • Add google analytics
  • Limit per user words at 5 a day (flask-limiter)
  • Add caching
  • Use this tool to fix errors https://github.com/kyrgyz-nlp/letter_replacer
  • Prepare prod and debug configs and corresponding environments
  • Write tests
  • Prepare CI & CD
  • Make a full-text search
  • Make a word page to show all definitions of given word
  • Integrate Google Translate from KG to RU/ENG
  • Make prettier logo
  • Customize website design
  • Make a created_at date more like whatsapp messages (added 8 minutes ago, ...)
  • Add authors pages and make authors nickname clickable in word section
  • Add share button
    • Export in pretty image format to instagram
    • Add text-to-speech
  • Make a script scraping often used words, that are not in dictionary
    • It might escape news portals, but they often use formal language
    • Try to make a scraper that pulls instagram/tik-tok comments, which often contain informal language
  • Make a bot that posts Word of the day on social media with pretty image formating

How it looks

Index Page Add word page Admin panel

tili20's People

Contributors

alpkarakush avatar

Stargazers

Alex Kuzmin avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.