Skip to content

Latest commit

 

History

History
150 lines (116 loc) · 3.99 KB

README.md

File metadata and controls

150 lines (116 loc) · 3.99 KB


Table of Contents
  1. About The Project
  2. Getting Started
  3. Contact

About the Project

Cruz is a desktop application that can perform data cross-referencing from Windows AD, Bitdefender Report, DHCP and Kace Report files.

When uploading the necessary files, it formats and manipulates them to be in a format that can be used for queries.

Then it performs queries on the database and filters the data. It manipulates the tables to generate a final report that will tell you which machines have or do not have each file.

(back to top)

Getting Started

To get a local copy and run it, follow these simple example steps.

Prerequisites

Installation

  1. Clone the repo 
    git clone https://github.com/PhMoraiis/cruz.git

Back-end

  1. Change directory 
      cd backend_app
  2. Install Bun packages 
    bun install
  3. Run the server 
    bun dev
  4. After that the server will start, the default path is http://localhost:8080
    Check the path in the console where you started the application.

Front-end

Alert

If you want to install the application from the latest build, skip the Front-end configuration step.

  1. Change directory

      cd .. & cd desktop_app

  2. Install Bun packages

    bun install

  3. Run the server

    bun dev

  4. After that the server will start, the default path is http://localhost:3000

  5. If your backend starts in another path, go to the file src/components/FormCard/index.tsx and change the request path.

await fetch(`<exchange here>/upload/${endpoint}`
  1. If your backend starts in another path, go to the file src/components/HomeCruz/index.tsx and change the request path.
await fetch(`<exchange here>/report/${type}?format=${format}`
  1. Enjoy the project!

(back to top)

Contact

Philipe Morais - [email protected]

Project Link: https://github.com/PhMoraiis/cruz

(back to top)