This project aims to be a simple, go-to place for querying the port status for a provided hostname or IP address.
🏠 Homepage
✨ Demo
The API documentation is automatically generated by FastAPI. Routes and specification can be found at https://portchecker.io/api/v1/docs
👤 Dan Hand
- Website: https://danielhand.io
- Github: @dsgnr
The project consists of two containers. The front-end is a static HTML file sat behind Nginx. The back-end is a simple API built using FastAPI.
The project aims to be super simple, with low overhead and also the least amount of dependencies as possible.
The project contains both production and development stacks. The production stack utilises Gunicorn as the API's gateway interface, whereas development utilises uvicorn.
Bringing up the development stack:
$ docker-compose -f docker-compose-dev.yml up --build
Bringing up the API outside of Docker;
$ cd backend/api; uvicorn main:app --reload
Bringing up the UI outside of Docker;
$ cd frontend/web; yarn install; yarn dev
The port checker API will be running at http://0.0.0.0:8000 and the front-end will be running at http://0.0.0.0:8080.
The following configuration options are available. These would be set within the Docker compose files.
- ALLOW_PRIVATE (boolean, default false)
- DEFAULT_PORT (integer, default 443)
Contributions, issues and feature requests are welcome.
Feel free to check issues page if you want to contribute.
Give a ⭐️ if this project helped you!
Running websites such as this comes with associated costs. Any donations to help the running of the site is hugely appreciated!
The site is located on Digital Ocean. You can use the following referral link to get some credit when joining:
Copyright © 2019 Dan Hand.
This project is MIT licensed.
This README was generated with ❤️ by readme-md-generator