Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

15 lines (12 loc) · 1.28 KB

This project is a project that is currently related to an ongoing co-op work. Issues / contributions / suggestions are still welcomed, but they may have a lower priority than the current ongoing development goal.

If you have any issues / concerns regarding this project, please follow the guidelines provided in the repository.

project structure

/app/ directory contains all the reactJS code that's used for the website.

  • /app/src/actions contains the js code used to communicate with the backend flask API server through axios.
  • /app/src/react-components contains all the React components used to render the website (powered by material-ui).
  • /app/src/App.js and /app/src/ToolBar.js contains most of the routing files.

/pyscript/ directory contains all the python scripts.

  • /pyscript/script/ contains the phonology problem generation scripts containing the algorithms / logic to generate a randomized phonology problem based on the given dataset.
  • /pyscript/script/data/ contains default dataset used by the python scripts
  • /pyscript/app/ contains the flask source code. Flask is used as an API server providing frontend React with formatted data generated by the python scripts.
  • backend uses sqlalchemy to manage user login information and keep track of generated quiz/question data.