https://github.com/nstechbytes/yourserver
YourServer is a simple local HTTP server with a GUI interface built using Tkinter. It allows users to serve a documentation directory locally and provides a system tray icon for easy access and control.
https://github.com/nstechbytes/yourserver
Last synced: 4 months ago
JSON representation
YourServer is a simple local HTTP server with a GUI interface built using Tkinter. It allows users to serve a documentation directory locally and provides a system tray icon for easy access and control.
- Host: GitHub
- URL: https://github.com/nstechbytes/yourserver
- Owner: NSTechBytes
- License: apache-2.0
- Created: 2025-02-06T15:22:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-07T09:23:24.000Z (over 1 year ago)
- Last Synced: 2025-02-07T10:24:34.939Z (over 1 year ago)
- Language: HTML
- Size: 20.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YourServer
A lightweight Python-based HTTP server with a GUI and system tray integration.
## Features
- Serves static files from the `documentation` directory.
- Automatically finds an available port starting from 2100.
- Minimal GUI for controlling the server.
- System tray integration to minimize the application.
## Prerequisites
Ensure you have Python installed (Python 3.x recommended). Install the required dependencies:
```sh
pip install pystray pillow
```
## How to Run
1. Clone the repository or copy the script to your local machine.
2. Run the script:
```sh
python yourserver.py
```
3. The server will start and be accessible at `http://localhost:`.
## Usage
- The application automatically looks for an available port.
- The GUI allows minimizing to the system tray.
- Click "Hide to Tray" to send the app to the system tray.
- Right-click the tray icon to show the window or exit the app.
## Directory Structure
```
.
├── yourserver.py # Main script
├── documentation # Folder to serve files from
```
## Troubleshooting
- If the `documentation` directory does not exist, the script will create it.
- If port 2100 is in use, the application will automatically find an available port.
## License
This project is licensed under the Apache License. Contributions are welcome! Feel free to open an issue or submit a pull request if you have any improvements or feature requests.