Skip to content

Codex-Management-Apps/PCBEE-Enterprise-Management-System

Repository files navigation

PC BEE Frontend

This pc bee frontend, utilizing electron to build a desktop application powered by vite and styled using shadcn ui components

Project Setup

To make this project run in your computer make sure that you have follow this steps.

Requirements

Install these tech to make the project running

  • Node.js v20.15^
  • Npm 10.8.^

Instalation

Before you start the backend make sure you to follow these steps to make sure everything runs well.

Get the projec by running

git clone https://github.com/khesir/PC-BEE-Frondend.git

Then run this to fetch the updates of the branch

git fetch

Then install all dependencies that will be used to this app

npm i

Finally, start the project by running

npm run dev

Code quality

Run this command to check for bugs for build and others : mainly spotting bugs

npm run lint

This works to re-format shitty codes to good quality ones

npm run format

Components

Don't create base components like input, buttons, import the components from shadcnui components

Documentation

As for the whole project documentation you can see it from here below I have listed everything such as:

  • Handling errors
  • Techstack
  • Dev ops (tools that we use in this project)
  • API documentation
  • Coding rules and guidelines
  • Documentation: click here