Knocker-EXPO: React EXPO client for Knocker

Knocker-EXPO is an app for Knocker written in Expo (React Native) that provides a convenient way to whitelist your device's IP address with a compatible server. It is designed for users who need temporary access to protected networks or services and want a simple, reliable tool to manage it.

✨ Features

• One-Tap Whitelisting: A prominent "Knock" button to instantly whitelist your current IP address.
• Automatic Knock: The app automatically knocks on launch
• Background Service: An optional background service that re-knocks with a schedule of at least 15 minutes to ensure your access doesn't expire.
• Reliability Hints: Automatic detection of missed background runs with Android-specific guidance to disable battery optimizations when needed.
• Secure Storage: All sensitive credentials (endpoint, token) are stored securely on your device using expo-secure-store.

Install

The app has been tested on android. An apk is available under the latest release in the Releases Tab. APKs are also build on changes to the code or the pipelines

development

Prerequisites

• Node.js (LTS version recommended)
• Expo CLI
• A compatible Knocker server instance.

Installation & Setup

1. Clone the repository:

   git clone https://github.com/your-username/knocker-expo.git
   cd knocker-expo

2. Install dependencies:

   npm install

3. Run the application:

   npm start

   This will start the Metro bundler. You can then run the app on an Android emulator or a physical device using the Expo Go app.

4. Configure the App:

   • On the first launch, you will be directed to the Setup screen.
   • Enter the full URL of your Knocker server endpoint (e.g., http://your-server.com/knock).
   • Enter the secret API token for your server.
   • Optionally, enable the background service.
   • Tap Save.

🛠️ Development

This project follows a strict Test-Driven Development (TDD) methodology. All code is thoroughly tested using Jest and React Native Testing Library.

• Run all tests:

  npm test

• Run tests for a specific file:

  npm test src/path/to/your/file.test.ts

📄 Documentation

Detailed documentation for the project can be found in the /docs directory:

• project-overview.md: High-level summary of the project.
• architecture.md: Explanation of the software architecture and data flow.
• design.md: Overview of the UI/UX design and Material You implementation.

🤝 Contributing

Contributions are welcome! Please feel free to open an issue or submit a pull request.