Skip to content

README.md

Latest commit

 

History

History
125 lines (89 loc) · 8.09 KB

README.md

File metadata and controls

125 lines (89 loc) · 8.09 KB
Raw

Web FPGA Team 2

Overview • What's a FPGA • Requirements • Key Features • How to Run • How to Use It • Documents • License

🖥️⚡Overview

We develop a web interface for an FPGA Simulator. This web interface will be used to teach people how the signals propagate inside an FPGA.


👤 Contributors
Photo Role Name Contact
Project Manager Enoal ADAM GitHubLinkedIn
Program Manager Salaheddine NAMIR GitHubLinkedIn
Tech Lead Léna De GERMAIN GitHubLinkedIn
Software Developer Ian LAURENT GitHubLinkedIn
Software Developer Lucas AUBARD GitHubLinkedIn
Quality Assurance Mattéo LEFIN GitHubLinkedIn

🛠️🧑‍💻 What's a FPGA ?

An FPGA is a reprogrammable electronic chip that allows users to create custom circuits. Unlike traditional processors (CPUs) that execute instructions, an FPGA can be configured to function as a specialized circuit optimized for a specific task. It is widely used in fields like aerospace, automotive, and telecommunications because it offers high flexibility and speed.

🔑 Requirements to Access the Website

To access our website, you need a Chromium-based browser (Edge, Chrome, Opera, etc... ) or Firefox.

🌟 Key Features

Feature Description
Friendly interface Intuitive, easy-to-use UI for seamless navigation and interaction.
Account system possibility of logging on as teacher or student
Load .v and .sdf files The teacher can upload the Verilog file for display on the student's side.
Connection between Teacher's side and Student's side If the teacher uploads a file or deletes the current schema, it will modify the interface on the student side.
Display an animated schematic with values A schematic of the various components of the file will be displayed in a simplified way and with animations representing the current flowing between the various circuit components.

▶️ How to Run

This project uses a full-stack architecture with a backend and a frontend.

🖥 Requirements

  • Node.js (v18 or higher)
  • npm
  • A terminal (macOS/Linux) or Command Prompt (Windows)

🔧 Installation

Clone the repository:

git clone https://github.com/algosup/2024-2025-project-4-web-fpga-team-2.git
cd 2024-2025-project-4-web-fpga-team-2

🚀 Run the Project

On macOS / Linux

chmod +x run_project.sh
./run_project.sh

This script will:

  • Start the backend (src/Backend) in the background
  • Automatically install missing dependencies
  • Start the frontend (src/Frontend) in development mode
  • Open your browser at http://localhost:5173

On Windows

Simply double-click run_project.bat or run it from the terminal:

run_project.bat

It will:

  • Start both the backend and frontend
  • Install any missing dependencies
  • Open your browser to http://localhost:5173

📖 How to Use It ?

You can access the website by clicking on this link.

🧑‍🏫 Note: To access the Teacher page, you will be prompted for a password. The default password is: securepass.

📂 Project Documents

📄 Functional Specifications
⚙️ Technical Specifications
🧪 Test Plan
✅ Test Cases Rules
📑 Management Artifacts
📆 Weekly Reports
📌 Post Mortem

⚖️ License

This project is under license MIT - see the LICENSE file for more information.