about summary refs log tree commit diff
diff options
context:
space:
mode:
authorBaitinq <30861839+Baitinq@users.noreply.github.com>2024-09-01 17:39:49 +0200
committerGitHub <noreply@github.com>2024-09-01 17:39:49 +0200
commitd9b473b544d10e089477fc0ac2f084953436d96a (patch)
tree049e1e78d2379e394c3ce596e91ed752f2fa6dfe
parentPages: File: Add functionality to restore button (diff)
downloadfs-tracer-frontend-d9b473b544d10e089477fc0ac2f084953436d96a.tar.gz
fs-tracer-frontend-d9b473b544d10e089477fc0ac2f084953436d96a.tar.bz2
fs-tracer-frontend-d9b473b544d10e089477fc0ac2f084953436d96a.zip
Update README.md
-rw-r--r--README.md32
1 files changed, 7 insertions, 25 deletions
diff --git a/README.md b/README.md
index 0d6babe..3b76048 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,12 @@
-# React + TypeScript + Vite
+# fs-tracer-frontend
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+This repository contains the frontend for the fs-tracer project, providing a user interface to view and manage file system modifications tracked by the eBPF agent.
 
-Currently, two official plugins are available:
+## Overview
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+The frontend is built using React and TypeScript, offering a responsive and intuitive user experience. It interacts with the backend services via RESTful APIs to display recent file changes, allow searches, and manage file versions.
 
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
-
-- Configure the top-level `parserOptions` property like this:
-
-```js
-export default {
-  // other rules...
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-  },
-}
+## Running
+```bash
+npm run dev
 ```
-
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list