anthracite/README.md

35 lines
1 KiB
Markdown
Raw Normal View History

2023-09-06 20:44:29 +00:00
# Anthracite
2023-10-20 16:46:30 +00:00
A simple web server written in C++. Supports HTTP 1.0 & 1.1.
2023-09-07 23:33:22 +00:00
2023-10-20 16:46:30 +00:00
## Developing
2023-09-07 23:33:22 +00:00
2023-10-20 16:46:30 +00:00
To build/develop Anthracite, you must have C++20, Make, and Python3 installed.
2023-09-07 23:33:22 +00:00
2023-10-20 16:46:30 +00:00
You can run Anthracite with: `make run`
2023-09-06 20:44:29 +00:00
## Todo
2023-10-20 16:46:30 +00:00
- [x] HTTP/1.0
2023-09-06 20:44:29 +00:00
- [x] Serve HTML Pages
2023-09-07 23:33:22 +00:00
- [x] Properly parse HTTP requests
- [x] Add module-based backend system for handling requests
2023-10-16 18:39:32 +00:00
- [x] Multithreading
2023-10-20 16:46:30 +00:00
- [x] HTTP/1.1
- [ ] Improve benchmarking infrastructure
- [ ] Faster parsing
- [ ] Fix glaring security issues
2023-09-07 23:33:22 +00:00
- [ ] Proper error handling
2023-10-20 16:46:30 +00:00
- [ ] User configuration
2023-10-16 18:39:32 +00:00
- [ ] Build out module-based backend system for handling requests
2023-10-20 16:46:30 +00:00
- [ ] HTTP/2
- [ ] Enhance logging
- [ ] Cleanup (this one will never truly be done)
2023-09-06 20:52:18 +00:00
## Screenshots
![A picture of the default index.html page used by Anthracite](https://github.com/nickorlow/anthracite/blob/main/.screenshots/default-page.png?raw=true)
![A picture of the Anthracite default 404 not found page](https://github.com/nickorlow/anthracite/blob/main/.screenshots/404-page.png?raw=true)
2023-09-07 23:33:22 +00:00
---
_"By industry, we thrive"_