Networking-Toolbox

---

Deploying

Option 1 - Docker

Run docker run -p 3000:3000 mwakidenis/networking-toolbox Or, use our example docker-compose.yml

Option 2 - Cloud

Fork the repo, and import into Vercel, Netlify or any static hosting provider of your choice.

Option 3 - Source: Node

Follow the dev steps below. Then run npm run build:node to compile output. You can then start the server with node build.

Option 4 - GitHub Pages

Fork the repo. Head to the Actions tab, find the "Deploy to GitHub Pages" workflow, and trigger it. Then go to Settings > Pages > Source and select the gh-pages branch. Visit https://<your-username>.github.io/networking-toolbox/ to see your deployed app.

Option 5 - Source: Static

Follow the dev steps below. Then run npm run build:static to compile output. And upload the contents of ./build to any web server, CDN or static host.

Option 6 - Source: Docker

Follow the dev steps below. Then run docker build -t networking-toolbox . to build the image. You can then start the container with docker run -p 3000:3000 networking-toolbox.

Option 7 - Source: Other Platforms

You can build the app from source for a variety of platforms. This is done via SvelteKit adapters. First, follow the dev steps below. Then, simply set the DEPLOY_ENV environmental variable, to one of vercel, node, docker, netlify, static or just auto, and build the app For example: DEPLOY_ENV='node' npm run build

---

Developing

Prerequisites

You'll need Node.js installed, as well as Git and optionally Docker. The app is build with Svelte + SvelteKit in TypeScript.

Setup Commands

git clone git@github.com:mwakidenis/networking-toolbox.git
cd final-networking-toolbox
yarn
yarn dev

Testing

Before merging, code must pass all unit and end-to-end tests, as well as linting, type checks, svelte check and build checks.

yarn test

Building

• npm run dev - Starts the development server with hot reload/HMR
• npm run build - Builds the app for production
  • Note: choose adapter for platform by setting the DEPLOY_ENV var (see above)
• npm run preview - Test your build locally (build required first)
• npm start - Starts the production app (build required first)

Testing

• npm test — Run unit tests with Vitest
• npm run test:api — Run API tests
• npm run test:e2e — Run Playwright end-to-end tests
• npm run test:coverage — Generate test coverage

Checking

• npm run check — SvelteKit checks (types & diagnostics)
• npm run types — TypeScript-specific strict checking
• npm run lint — ESLint on all TS and Svelte files
• npm run format — Format files with Prettier
• npm run build-check — Quitley check build works

---

Contributing

Contributions are welcome (and much appreciated!) Follow the dev instructions above to get started, then check the Contributing Guidelines, and submit your changes as a PR. If you're new to GitHub or open source, take a look at git-in.to for a guide on getting started.

---

Features

---