Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 2.49 KB

README.md

File metadata and controls

66 lines (46 loc) · 2.49 KB
Raw

Nexus

Nexus is a powerful solution for visualizing and managing complex project structures. By providing a clear and interactive overview of project components and their relationships, this tool enhances transparency, communication, and decision-making, ultimately leading to more successful and efficient project execution.

image

Demo Video

https://youtu.be/8McLDcL-MpQ
Built at FOSS Hack 2024

Features

  • User can give their local folder path to get visualisations.
  • User can visualise their repositories using the dynamic flow chart .
  • Use of various colours to represent the hierarchy of the directories and the files
  • User can change the structure of the code to generate the JSON File.
  • The User can specify which all files or folders he wants to omit from the visualisation.
  • Use the JSON File thus generated to make flows for the code and for the user to edit accordingly.

🛠 Installation Steps:

Note

Run the commands before starting the client and server

pnpm i

To run only the client

pnpm start:client

To run only the server

pnpm start:server

To run both client and server at the same time

pnpm dev

Acknowledgements

This project makes use of the following libraries:

  • Biome - A formatter which is better used for linting and formatting purposes
  • React-Flow - A customizable React component for building node-based editors and interactive diagrams
  • DagreJS- A Library that generates layout
  • HeadlessUI - Completely unstyled, fully accessible UI components, designed to integrate beautifully with Tailwind CSS.
  • FileSaver - FileSaver.js is the solution to saving files on the client-side, and is perfect for web apps that generates files on the client
  • pnpm - Fast Disk Space Efficient Package Manager.

Future Implementations

  • Integration of CI/CD tools like GitHub.
  • Integrate LLM for cool explanation and understanding

Challenges Faced

  • Making the recursive function for the generation of nodes.
  • Making the service functions for the backend and its clean implementation
  • Implementing pnpm workspaces for running client and server together