traceroute_map/README.md

48 lines
933 B
Markdown
Raw Normal View History

2024-06-02 00:22:00 +03:00
# Traceroute Internet Mapper - TIM
## Development
2024-06-05 22:59:20 +03:00
### Backend
Pre-requisites: `pipenv`, or whichever venv manager you prefer
2024-06-02 00:22:00 +03:00
```sh
# Install all dependencies. `pipenv` was used previously:
pipenv --python 3.11
pipenv install
# Start dev server
2024-06-05 22:59:20 +03:00
pipenv shell
2024-06-02 00:22:00 +03:00
fastapi dev app/main.py
# Start posting data to the tracing endpoint:
traceroute git.rauhala.info -q1 | http POST localhost:8000/trace/MYHOSTNAME
```
2024-06-05 22:59:20 +03:00
### Frontend
Pre-requisites: `nvm`, `tsc` / `typescript`
```sh
# Install latest npm version with node version manager:
nvm install 22
# Install project packages:
npm install
# Regular usage, activate project node version & start TS compiler in watch mode:
nvm use
tsc -w
```
2024-06-02 00:22:00 +03:00
## 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