Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"zencoder.enableRepoIndexing": true
}
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,17 @@ MeterX consists of two main components:
yarn install
```

4. Start the server:
4. Build and start the server:
```bash
npm run build
npm start
# or
yarn build
yarn start
```
By default, the server will run on `http://localhost:3000`. You can configure the port in `server/index.js` or via environment variables if you modify the code.

5. **Important:** If you self-host the server, you'll need to update the `serverUrl` in the extension's configuration (e.g., in `extension/scripts/config.js` or a similar settings file) to point to your server's address.
5. **Important:** If you self-host the server, you'll need to update the `SERVER_URL` variable in the extension's `popup.ts` file to point to your server's address.

## 📖 Usage

Expand All @@ -97,7 +99,8 @@ MeterX consists of two main components:
* **Browser Extension:**
* HTML5
* CSS3
* JavaScript (Vanilla JS)
* TypeScript
* Vite (for building)
* WebExtensions API (Manifest V3)
* **Speed Test Server:**
* Node.js
Expand All @@ -111,18 +114,20 @@ MeterX consists of two main components:
```text
MeterX/
├── extension/ # Browser extension code
│ ├── icons/
│ ├── popup/
│ │ ├── popup.html
│ │ ├── popup.css
│ │ └── popup.js
│ ├── scripts/
│ │ ├── background.js (if any)
│ │ └── content.js (if any)
│ └── manifest.json
│ ├── images/ # Icons and images
│ ├── dist/ # Built files (generated by Vite)
│ ├── popup.html # Popup HTML structure
│ ├── popup.css # Popup styling
│ ├── popup.ts # Popup TypeScript code
│ ├── background.ts # Background service worker TypeScript code
│ ├── vite.config.ts # Vite configuration
│ ├── build.ps1 # Build script
│ └── manifest.json # Extension manifest
├── server/ # Node.js speed test server code
│ ├── node_modules/
│ ├── index.js # Main server file
│ ├── server.ts # Main server file
│ ├── test.ts # Test utilities
│ ├── vite.config.ts # Vite configuration for server
│ └── package.json
├── .gitignore
├── LICENSE
Expand Down
28 changes: 28 additions & 0 deletions extension/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.0.0] - 2024-08-28

This is a major update, featuring a complete rebranding, significant new features, and a major technical overhaul for better performance and maintainability.

### 🚀 New Features

- **Test Depth Selection**: Users can now select the size of the test file (1MB, 10MB, or 25MB) directly from the popup. This provides greater flexibility and allows for more accurate speed measurements, especially on very fast or very slow connections.
- **Test History**: The popup now displays a history of the last 10 speed tests performed. This allows users to easily track their internet performance over time without leaving the extension.

### 🎨 UI & UX Enhancements

- **Complete Rebranding**: The extension has been rebranded from "MeterX" to **"NetPulse Pro"**.
- **Redesigned Interface**: The user interface has been completely redesigned with a modern, clean, and more engaging look. This includes new icons and fun, space-themed doodles to enhance the user experience.
- **Improved Status Updates**: Status messages during the test are now more descriptive, creative, and informative, keeping the user engaged throughout the testing process.
- **Loading Indicator**: A visual spinner is now displayed while a test is in progress, providing clear visual feedback that the extension is working.

### 🛠️ Technical Improvements

- **Codebase Refactor to TypeScript**: The entire frontend logic for the popup has been migrated from JavaScript to TypeScript. This enhances code quality, maintainability, and developer experience through static typing.
- **Robust Error Handling**: Error handling has been significantly improved to catch and display more user-friendly messages if a test fails, providing better insight into what went wrong.
- **Dynamic Test Configuration**: The background service can now dynamically configure tests based on user selections from the popup, such as the chosen test file size.
206 changes: 0 additions & 206 deletions extension/background.js

This file was deleted.

Loading