SmartKey Android App Development

Project Overview:
SmartKey is a custom keyboard app for Android that integrates with OpenAI's API to provide real-time grammar correction and tone adjustment features. The app is intended to replace the default keyboard and help users improve the clarity and tone of their communication. The app should allow users to switch between formal and casual tones, ensuring that their text is grammatically correct and appropriately toned.

The scope of the project includes both front-end (Android) and back-end (Node.js) development, integration of the OpenAI API, and deployment to a server for real-time text processing.

Core Functionalities:
Grammar Correction: Automatically corrects grammar errors in real-time as users type on the keyboard.
Tone Adjustment: Provides the option to adjust the tone of the text (formal or casual).
Users can toggle between formal and casual tones via a settings option in the keyboard app.
Project Scope:
1. Front-End (Android App) Requirements:
The Android app will function as a keyboard that integrates with the OpenAI API for grammar correction and tone adjustment. The keyboard should replace the default keyboard, and users can switch to SmartKey from the system settings.

Key Features:
Custom Keyboard:

Replace the default Android keyboard with SmartKey.
Capture text input in real-time from any app where the keyboard is used.
Send text to the backend for grammar correction and tone adjustment.
Grammar Correction:

Automatically correct grammatical errors as the user types.
Display corrected text instantly in the text input field.
Tone Adjustment:

A toggle switch in the settings (or on the keyboard) to allow users to select the tone of their text: formal or casual.
Apply the selected tone adjustment to the input text.
Settings Activity:

Allow users to toggle between formal and casual tones.
Option to manage additional preferences (e.g., enable/disable grammar correction).
User Flow:
Onboarding:
A welcome screen explaining SmartKey's core features (grammar correction and tone adjustment).
Instructions for setting SmartKey as the default keyboard.
Main Keyboard Interface:
A clean and intuitive keyboard layout for typing.
Real-time text correction with grammar and tone adjustments.
Settings Interface:
A simple switch for users to change between formal and casual tone.
Development Notes:
Use Kotlin as the primary development language.
Follow Android design guidelines to ensure a smooth and consistent user experience.
Include support for Android API Level 21 (Lollipop) and above.
Ensure the app handles API errors gracefully (e.g., in case of server downtime).
Permissions:
INTERNET permission for connecting to the backend API.
BIND_INPUT_METHOD permission to function as a custom keyboard.
2. Back-End (Node.js) Requirements:
The backend will handle requests from the Android app and process text input using the OpenAI API for grammar correction and tone adjustment.

Key Features:
API Endpoint:
A POST endpoint /process-text to receive text and tone data.
Process the text using OpenAI's API to correct grammar and adjust tone.
Grammar Correction and Tone Adjustment:
Integrate OpenAI's GPT model to correct grammar and adjust text tone (formal/casual).
Security:
Use CORS to allow requests only from the SmartKey app.
Ensure the server is secured and follows best practices (e.g., HTTPS for production).
Development Notes:
Use Express.js for the backend server.
The server should be deployed to Heroku, AWS, or a similar service for public access.
The OpenAI API Key should be stored securely (in environment variables).
Sample API Request:
Request Body:
json
Copy code
{
"text": "your input text here",
"tone": "formal" // or "casual"
}
Response Body:
json
Copy code
{
"processedText": "Corrected and tone-adjusted text here"
}
Project Deliverables:
1. Android App:
APK file for testing.
Source code written in Kotlin following best practices.
Complete app with:
Custom keyboard.
Grammar correction functionality.
Tone adjustment functionality.
Settings activity to toggle between formal and casual tone.
2. Backend Server:
Node.js server with an API to process text requests.
Integration with the OpenAI API for grammar correction and tone adjustment.
Deployment to a cloud service (e.g., Heroku or AWS).
Documentation on how to deploy the backend on different cloud platforms.
Technical Requirements:
Frontend:
Platform: Android (API Level 21+)
Language: Kotlin
Permissions:
INTERNET
BIND_INPUT_METHOD
Backend:
Platform: Node.js
API Integration: OpenAI API
Deployment: Heroku, AWS, or equivalent
Project Milestones:
Phase 1 - Initial Setup:

Frontend: Basic keyboard setup with grammar correction functionality.
Backend: API endpoint for grammar correction.
Phase 2 - Tone Adjustment:

Frontend: Add settings for tone adjustment (formal/casual).
Backend: Update API to adjust tone based on user input.
Phase 3 - Testing & Deployment:

Test integration between frontend and backend.
Deploy the backend server.
Final APK release.
Timeline:
Phase 1: 1 week
Phase 2: 1 week
Phase 3: 1 week
Total Timeline: 3 weeks (can be adjusted based on discussions with the freelancer)
Budget:
Please provide a detailed cost breakdown for both the front-end and back-end development, including testing and deployment.

Skills Required:
Kotlin (Android Development).
Experience building custom Android keyboards.
Node.js and Express.js experience.
Familiarity with API integration (especially OpenAI API).
Cloud deployment knowledge (Heroku, AWS, etc.).
Additional Information:
The focus of the app is strictly on grammar correction and tone adjustment. No additional features are required.
The freelancer must provide documentation for both the frontend and backend, including how to set up and deploy the backend server.