README.md

whatsth.is

React-based progressive web app proof-of-concept designed to provide a toolbox of assorted helpful development tools. The current options are:

• Website Inspector (Beta - uses the API).
• DNS Inspector (Beta - uses the API).
• String Conversion (encode & encrypt).
• Colour Tools.
• Cron Conversion.
• UNIX Timestamp Converter.

This app comprises of three components - A React frontend (this repository), an engine library, and a C# .NET inspection API.

Getting Started

With Gitpod

(Will clone and setup a workspace of both front and back-end code!).

With Docker

You can quickly jump into project development using Docker with the compose script:

docker-compose up --build

This will start-up a dynamically recompiling ReactJS server on localhost:3000, but will also download the latest edge image of the whatsth.is API server, and run that too. This effectively gives you the entire system on your computer to play with.

Without Docker

Note you will need to either run a copy of the API server (you can override with .env.local), or by default it will connect to production (api.whatsth.is).

This project requires NodeJS to develop, test and compile the code. The following will quickstart you.

npm install
npm start

The API the system will communicate with is defined in the appropriate .env.

Testing Offline Capabilities

If you want to test the PWA functionality locally, you can add the following to the VitePWA() segment in vite.config.ts:

devOptions: {
	enabled: true
},