DS_Tutor

---

🙆‍♂️ A better web app for data structure visualization and tutoring.

---

🏁 Getting start

To learn more about this project please check this demo video and slide.

🔨 Build from source

First clone the project to local.

$ git clone [email protected]:tin0819tin/DS_Tutor.git

Setup Flask Server

1. Enable backend virtual environment

source api/bin/activate 

2. Set Flask variables

export FLASK_APP=main.py

3. Run DS_Tutor

flask run --reload --debugger

It will open DS_Tutor on http://127.0.0.1:5000/

4. Unable virtual environment

deactivate

⚙️ Deployed Version

We have deployed our project on heroku, however since our budget is limited, our plan can't serve large traffic. As a result, we currently don't open the deployment link to public.

💡 Usage

Flask api definition

For developer, if you are just using DS_Tutor, you could skip this table.

Description	Methods	Binary Search Tree	Min Heap	Max Heap	Red Black Tree
The page showing the Data Structure	root api	/bst	/minHeap	/maxHeap	/rbTree
Insert the node with	/<DS>/insert/<value>	✅	✅	✅	✅
Delete the node with	/<DS>/delete/<value>	✅	❌	❌	✅
Find the node with	/<DS>/find/<value>	✅	❌	❌	✅
Print the DS inorderly	/<DS>/print	✅	❌	❌	✅
Remove minimum node	/<DS>/rMin	❌	✅	❌	❌
Remove maximum node	/<DS>/rMax	❌	❌	✅	❌
Clear the DS	/<DS>/clear	✅	✅	✅	✅

🖍️ DIY mode

Check the DIY page on /bst, /minHeap, /maxHeap and /rbTree.

📄 Test your knowledge mode

Check the test your knowledge page on /tutor.