Giter VIP home page Giter VIP logo

teachyourselfmath's Introduction

teachyourselfmath

I wished for a free website with an ever-growing list of math problems, teachyourselfmath is that website.

how does it work

If a document containing math problem exists, we'd like to extract every problem from it and dump it in a database. LaTeX is something that can be understood by both, computers and humans. Hence, the problem boils down to converting a PDF into LaTeX, removing the irrelevant parts, and storing the remaining parts.

Meta came up with a model to parse academic PDF documents and find the LaTeX math in it.

Currently, I run this model's server locally on my computer with every PDF I can get my hands on. The main server has a queue-based system that interacts with the model's server and processes all the problems. Here is a visual illustration of how it works:

flow of all the steps

setup

  1. Get nougat from here. Run it as a server.
  2. You will need PostgreSQL and Redis to run this.
  3. yarn
  4. yarn build
  5. Setup the .env file using the .env.example file.
  6. yarn start!

acknowledgements

created by Vivek Nathani (@viveknathani_), licensed under the MIT License.

teachyourselfmath's People

Contributors

viveknathani avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

teachyourselfmath's Issues

chore: open source

  1. MIT license - DONE
  2. README - DONE
    • what
    • why
    • how
    • instructions to build from the source
    • how to contribute - this is silly, people know this already
  3. GitHub action to build the code on every pull request. - DONE
  4. links and descriptions - DONE
  5. accessible on multiple pages/profiles - DONE
  6. tagging via git - DONE

feature: get problems by category

you can tap onto any category from the link under the problem in the list of problems but apparently, it is not accessible or obvious.

what do users say:

  1. "add a section wise search"
  2. "it's cumbersome to first look for a particular type of question and then specifically clicking for the little text below"
  3. "is there a filter for topic?"
  4. "and if I want to change the category I need to go back?"
  5. "a side bar which slide opens with the list of categories"
  6. "what happens when I click on complex numbers?"

UX improvements

  • Make questions clickable
  • Remove underline on comment & category under question
  • Login page <br/>
  • Change comment button to login to comment button if the user isn't logged in

feature: profile page

post login, turn the "login" text into "profile" and let it go to a profile page that has the following details:

  1. name
  2. username
  3. email
  4. list of problems user has commented on

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.