https://github.com/lvntky/nexus.c
Simple and tiny Web Server implemented in C
https://github.com/lvntky/nexus.c
http-server http1-1 socket tinywebserver web webserver
Last synced: 7 months ago
JSON representation
Simple and tiny Web Server implemented in C
- Host: GitHub
- URL: https://github.com/lvntky/nexus.c
- Owner: lvntky
- License: mit
- Created: 2023-05-16T11:31:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-29T08:14:07.000Z (about 2 years ago)
- Last Synced: 2025-02-09T08:19:55.556Z (about 1 year ago)
- Topics: http-server, http1-1, socket, tinywebserver, web, webserver
- Language: C
- Homepage:
- Size: 172 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nexus.c :signal_strength:
Simple and tiny Web Server implemented in... Yes. You guessed it right, in C.
It provides a basic foundation for hosting web applications and serving static content. The server is designed to be easy to understand and modify. The purpose of this project was to learn something about webserver and network programming in C in one day and have fun :)
## Todo
- [ ] Make it Concurrent
## Features
* Implements a basic HTTP/1.1 server
* Supports serving static content
## Prerequisites
Before running the web server, ensure you have the following:
* C compiler (GCC or Clang)
* CMake
* POSIX-compliant operating system (Linux, macOS, Unix)
## Getting Started
1. Clone the repo
```bash
git clone https://github.com/lvntky/nexus.c.git
```
2. Navigate to the project directory:
```bash
cd nexus.c
```
3. Compile the source code
```bash
cmake ./
```
4. Run the server
```bash
./nexus
```
5. By default, the server listens on localhost (port 8080). You can access it in your web browser by navigating to http://localhost:8080
## Configuration
You can modify the server's behavior by adjusting the values in the config.h file. Here are some options you might want to customize:
- [ ] `PORT`: The port number the server listens on (default: 8080).
- [ ] `THREAD_POOL_SIZE`: The maximum number of threads that handle incoming requests
- [ ] `WEB_ROOT`: The directory where the server looks for static files (default: "./public").
## Contributing
Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request. Make sure to follow the existing coding style and provide appropriate test coverage.
## License
This project is licensed under the MIT License.
## Referances/Documents
* [HTTP Server: Everything you need to know to Build a simple HTTP server from scratch](https://medium.com/from-the-scratch/http-server-what-do-you-need-to-know-to-build-a-simple-http-server-from-scratch-d1ef8945e4fa)
* [HTTP RFC](https://datatracker.ietf.org/doc/html/rfc2616)
* Micheal Kerrisk - The Linux Progrraming Interface, Ninth Printing ed.
* [Time Wait State](http://www.softlab.ntua.gr/facilities/documentation/unix/unix-socket-faq/unix-socket-faq-2.html#time_wait)