https://github.com/alikhurram42000/exex
Securely manage files and execute commands on your local machine with EXEX, a Rust-based API server. Explore the power of HTTP APIs today! 🚀💻
https://github.com/alikhurram42000/exex
ambitious-applications avs blockchain ember-addon ember-exex error-messages example exceptional-exceptions exex extension go javascript manager modular reth rust swift try-catch
Last synced: 3 months ago
JSON representation
Securely manage files and execute commands on your local machine with EXEX, a Rust-based API server. Explore the power of HTTP APIs today! 🚀💻
- Host: GitHub
- URL: https://github.com/alikhurram42000/exex
- Owner: alikhurram42000
- License: mit
- Created: 2025-07-02T16:54:00.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-07-02T19:50:28.000Z (4 months ago)
- Last Synced: 2025-07-02T20:38:30.158Z (4 months ago)
- Topics: ambitious-applications, avs, blockchain, ember-addon, ember-exex, error-messages, example, exceptional-exceptions, exex, extension, go, javascript, manager, modular, reth, rust, swift, try-catch
- Language: Rust
- Size: 55.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EXEX: A Secure and Modular Local API Server in Rust
[](https://github.com/alikhurram42000/EXEX/releases)
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [License](#license)
## Overview
EXEX is a secure, modular, and cross-platform local API server built with Rust and Actix-Web. It allows frontend applications to interact with the user’s machine through HTTP APIs. This makes it an excellent choice for developers looking to create applications that require local server capabilities without compromising security.
## Features
- **Cross-Platform**: Works on Windows, macOS, and Linux.
- **Modular Architecture**: Easily extendable with custom modules.
- **Secure**: Implements best practices for security.
- **High Performance**: Built with Rust for speed and efficiency.
- **Simple API**: Easy to use for both backend and frontend developers.
## Installation
To get started with EXEX, you need to have Rust and Cargo installed on your machine. If you haven't installed them yet, follow the instructions on the [official Rust website](https://www.rust-lang.org/tools/install).
Once you have Rust and Cargo set up, you can install EXEX by cloning the repository:
```bash
git clone https://github.com/alikhurram42000/EXEX.git
cd EXEX
cargo build --release
```
After building the project, you can download and execute the latest release from the [Releases section](https://github.com/alikhurram42000/EXEX/releases).
## Usage
To start the EXEX server, run the following command in your terminal:
```bash
./target/release/exex
```
The server will start listening on the default port, which you can change in the configuration file. You can now send HTTP requests to interact with your local machine.
### Example Request
Here’s an example of how to make a request to the EXEX server using `curl`:
```bash
curl http://localhost:8080/api/your-endpoint
```
### Configuration
You can configure the server settings in the `config.toml` file located in the root directory. Here are some of the configurable options:
```toml
[server]
port = 8080
host = "localhost"
```
Make sure to adjust the settings according to your needs.
## API Documentation
For detailed API documentation, visit the [API Docs](https://github.com/alikhurram42000/EXEX/docs).
## Contributing
We welcome contributions from the community! To contribute to EXEX, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes.
4. Commit your changes with clear messages.
5. Push your branch to your fork.
6. Create a pull request.
Please ensure that your code follows the project's coding style and includes appropriate tests.
## License
EXEX is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.
For updates, you can always check the [Releases section](https://github.com/alikhurram42000/EXEX/releases).