speatzle/nfsense
1
0
Fork 0
mirror of https://github.com/speatzle/nfsense.git synced 2025-05-10 18:38:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
nfsense/client
History
Samuel Lorch 75322d4ece Add NAT Headings
2023-11-04 14:40:11 +01:00
..
public add initial test client 2023-03-06 23:56:36 +01:00
src Add NAT Headings 2023-11-04 14:40:11 +01:00
.gitignore Exclude settings.json from .gitignore 2023-11-02 23:03:19 +01:00
index.html add initial test client 2023-03-06 23:56:36 +01:00
package.json Fixed path aliases, added @ for components 2023-11-03 18:36:12 +01:00
pnpm-lock.yaml Fixed path aliases, added @ for components 2023-11-03 18:36:12 +01:00
README.md Added Structural Documentation 2023-11-03 19:35:45 +01:00
tsconfig.json Fixed path aliases, added @ for components 2023-11-03 18:36:12 +01:00
tsconfig.node.json add initial test client 2023-03-06 23:56:36 +01:00
vite.config.ts Added Structural Documentation 2023-11-03 19:35:45 +01:00

README.md

nfSense Web Client

This folder contains the standard client for the nfSense firewall.

Goals and Priorities

The nfSense web client should be...

  • As reliable as possible
  • Pleasing to the eye and intuitive to new users
  • Fast, and not get in your way.

Technology

General Structure

The nfSense web client is a monolithic Single-Page Web-Application.

Critical Dependencies

We encourage any potential contributor to familiarize themselves with these tools and libraries before making changes, as they lie at the heart of the project.

  • Vue 3: Frontend Framework
  • Vite: Dev and Build Tool
  • Typescript: Adds Type Information to JS
  • Vue Macros: Replacement for the deprecated experimental Reactivity Transform feature of Vue 3

Important Dependencies

These libraries aren't mandatory to be able to work on the nfSense web client, this listing is merely meant to pre-empt redundancies.

  • ESLint: The standard JS linter, which we also use to enforce some code style choices.
  • Iconify: Icons (Could be replaced with custom ones)
  • Markdown-It: We prefer markdown for informational texts, and use this to render it on the frontend.