# poket

`poket` is a lightweight URL forwarding service designed for self-hosting. Currently under active development, the project aims to provide a simple and efficient solution for managing and redirecting URLs within your own infrastructure.

## Current Status

This project is in its very early stages. The current implementation is a placeholder, and active development is underway to realize the full feature set described below.

## Intended Features (Under Development)

* **Lightweight and Efficient:** Built with Rust for performance and minimal resource consumption.
* **Self-Hostable:** Designed to be easily deployed and managed on your own servers.
* **URL Forwarding:** Core functionality for defining and managing URL redirects.
* **Container-Friendly:** Optimized for deployment within containerized environments.

## Getting Started (Development)

To build and run the current placeholder:

1. **Clone the repository:**

    ```bash
    git clone https://gitlab.com/hafijulali/poket.git
    cd poket
    ```

2. **Build the project:**

    ```bash
    cargo build
    ```

3. **Run the placeholder:**

    ```bash
    cargo run
    ```

    You should see the output:

    ```
    [INIT] Starting pocket web server
    ```

## Contributing

Contributions are welcome! Please feel free to open issues or submit pull requests on the [GitLab repository](https://gitlab.com/hafijulali/poket).

## License

This project is licensed under the terms of the [LICENSE](./LICENSE) file.

## Contact

* **Author:** Sheikh Hafijul Ali
* **Email:** <mail@hafijul.dev>
* **Repository:** [https://gitlab.com/hafijulali/poket](https://gitlab.com/hafijulali/poket)
