41 lines
1.3 KiB
Markdown
41 lines
1.3 KiB
Markdown
# Teapot Server
|
|
|
|
## Description
|
|
|
|
This is a simple "teapot server" project, inspired by the classic XKCD comic. It's designed to be a minimal HTTP server that responds with a 418 I'm teapot status and a humorous message about quantum fluctuations. The primary purpose is for demonstration and learning purposes, showcasing basic Go web development concepts.
|
|
|
|
## Usage
|
|
|
|
1. **Clone the repository:**
|
|
```bash
|
|
git clone https://gitea.mrixs.me/Mrixs/teapot-server.git
|
|
cd teapot-server
|
|
```
|
|
|
|
2. **Build the server:**
|
|
```bash
|
|
go build .
|
|
```
|
|
|
|
3. **Run the server:**
|
|
```bash
|
|
./teapot-server
|
|
```
|
|
|
|
4. **Access the server:** Open your web browser and navigate to `http://localhost:8080`. You should see a message about quantum fluctuations.
|
|
|
|
## Technical Details
|
|
|
|
* **Language:** Go (Golang)
|
|
* **Dependencies:** None (uses standard library only)
|
|
* **Port:** The server listens on port 8080 by default. This can be configured via command line argument `--port <port>`.
|
|
* **Error Handling:** Basic error handling is implemented to catch potential issues during startup and runtime.
|
|
|
|
## Contributing
|
|
|
|
Feel free to contribute by submitting bug reports or feature requests. Pull requests are welcome!
|
|
|
|
## License
|
|
|
|
This project is licensed under the [WTFPL License](LICENSE.md). See the `LICENSE` file for details.
|