vzou

Project Overview

[!NOTE] This project was originally started by a previous team (@gilbenhamo, @yovelal, @eodinzov94, @RonSCE) as a part of their final project, and we continued its development as part of our final project. We have added new features and improvements, including animations for various algorithms and data structures.

Many students struggle to grasp explanations of algorithms and data structures in traditional classroom settings. This project developed a web-based platform that animates these concepts, offering a more visual and intuitive way to understand how they function. The simulator helps users visualize each step of these algorithms and structures, enhancing their understanding and learning process. The main goal of this project is to make learning algorithms and data structures more interactive and accessible for students.

In addition to the previously developed animations, we have added the following new ones:

• Depth-First Search (DFS)
• Bellman-Ford Algorithm
• Prim's Algorithm
• Kruskal's Algorithm
• Breadth-First Search (BFS)
• Dijkstra's Algorithm
• Linked List
• Hash Table

https://github.com/user-attachments/assets/e5972e05-9fbb-44c6-81dd-c02f93bb35c9

Technologies Used

The project is built using modern web development technologies:

• Frontend: React, TypeScript, TailwindCSS, Framer Motion, Redux, D3.js
• Backend: Node.js, Express, PostgreSQL, Sequelize

Key Features

1. Interactive Algorithm Animations: Users can visualize algorithms in action, pause and play, move step by step, and adjust animation speed.
2. Graphical Data Structure Visualizations: Clear, step-by-step animations for data structures like linked lists and hash tables.
3. User Registration and Statistics: Users can sign up, log in, and user-lecturers can track which algorithms students have explored.
4. Clean and Responsive UI: Built using TailwindCSS for responsive design and user-friendly interaction.

Usage Instructions

1. Registration and Login: Users must register an account to access the platform.
2. Choose a Topic: After logging in, the user can select from three main categories on the homepage:
   • Graphs
   • Data Structures
   • Sorting Algorithms
3. View Animations: Once a topic is selected, users can start the animation for a specific algorithm or data structure. Controls include:
   • Play/Pause
   • Step forward/backward
   • Speed adjustment

How to Run the Project (click to expand)

To run the project locally, follow these steps:

Prerequisites

• Ensure that you have Node.js and Git installed.
• Clone the repository:

  git clone [email protected]:alechkos/vzou.git
  

Backend Setup

1. Navigate to the backend folder:

   cd backend
   

2. Install dependencies:

   npm install
   

3. Start the backend server:
   • For Node.js version compatibility:

     npm run dev
     

   • If the above fails due to version conflicts, try:

     npm run dev2
     

Frontend Setup

1. Navigate to the frontend folder:

   cd frontend
   

2. Install dependencies:

   npm install
   

3. Start the frontend development server:

   npm run start
   

Future Development

There are several potential areas for further development:

• Adding More Algorithms: Extending the platform to include additional algorithms and data structures.
• Improving the UI: Further refining the user experience with more intuitive controls and a cleaner interface.
• Mobile Version: Adapting the platform for better mobile compatibility.