This commit is contained in:
ryyst 2024-06-02 00:22:00 +03:00
parent f82a95ab8d
commit c4244e86e6

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# Traceroute Internet Mapper - TIM
## Development
```sh
# Install all dependencies. `pipenv` was used previously:
pipenv --python 3.11
pipenv install
pipenv shell
# Start dev server
fastapi dev app/main.py
# Start posting data to the tracing endpoint:
traceroute git.rauhala.info -q1 | http POST localhost:8000/trace/MYHOSTNAME
```
## URLs of interest
- http://localhost:8000/
- API Index, nothing to see.
- http://localhost:8000/docs/
- Autogenerated API docs, mildy interesting
- http://localhost:8000/static/index.html
- Rendered HTML index, very interesting