Xkeystroke UI

Xkeystroke UI is a web interface for Xkeystroke, providing a dashboard and user management functionalities. This project uses React for the frontend and Express.js for the backend.

Table of Contents

• Installation
• Running the Application
• Current Features
• Acknowledgements
• Contributing
• License
• Contact

Installation

Prerequisites

• Node.js (v14 or later)
• npm (v6 or later)

Clone the repository

git clone https://github.com/aiosint/xkeystroke-ui.git
cd xkeystroke-ui

Install dependencies

Run npm install in the repository root, then navigate to the server directory and install server dependencies:

npm install
cd server
npm install

Running the Application

Start the frontend & backend

From the root directory, run:

npm start

This command will start both the backend Express.js server on port 3001 and the frontend React development server on port 3000.

Access the application

Open your web browser and navigate to http://localhost:3000.

Current Features

• User authentication (Login/Signup)
• Dashboard with various widgets
• User management for admin users
• Profile management & Usage
• Admin Features
  • View all users
  • Change user roles
  • Delete users
• User Features
  • View and update profile
  • Copy user UUID
• API Endpoints

A lot more to come...

Acknowledgements

This project utilizes the Aibolit scanner for malware and virus scanning. The Aibolit scanner is developed by Greg Zemskov and is available for non-commercial use. We have built upon this tool to enhance our application's security features.

Contributing

• Fork the repository.
• Create a new branch for your feature or bug fix.
• Submit a pull request with a detailed description of your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For questions or support, please contact [your email].