{"id":23176766,"url":"https://github.com/ryanlarge13/txt-me","last_synced_at":"2025-04-05T01:24:30.237Z","repository":{"id":225754422,"uuid":"766318984","full_name":"RyanLarge13/Txt-Me","owner":"RyanLarge13","description":"Txt Me Frontend built with React","archived":false,"fork":false,"pushed_at":"2025-03-28T14:40:22.000Z","size":1490,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-28T15:36:21.866Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://txt-me.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RyanLarge13.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-02T23:31:09.000Z","updated_at":"2025-03-28T14:40:26.000Z","dependencies_parsed_at":"2024-07-17T19:33:49.990Z","dependency_job_id":"d993b0ef-8738-43dc-a8fe-b3062c5c95d7","html_url":"https://github.com/RyanLarge13/Txt-Me","commit_stats":null,"previous_names":["ryanlarge13/txt-me"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanLarge13%2FTxt-Me","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanLarge13%2FTxt-Me/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanLarge13%2FTxt-Me/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanLarge13%2FTxt-Me/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RyanLarge13","download_url":"https://codeload.github.com/RyanLarge13/Txt-Me/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247273452,"owners_count":20911932,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-18T06:19:32.086Z","updated_at":"2025-04-05T01:24:30.214Z","avatar_url":"https://github.com/RyanLarge13.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Txt Me\n\n**Txt Me** is a progressive web application (PWA) that delivers a secure, seamless, and customizable messaging experience. Built with **end-to-end encryption**, Txt Me ensures your conversations stay private, while providing a clean and intuitive user interface that can be customized to fit your style.\n\nThe app supports a variety of messaging formats, including text, images, videos, and links. With features like **group messages**, **contact management**, and **real-time syncing** across devices, Txt Me is designed for both individual and group communication.\n\n## Table of content\n\n- [Features](#features)\n- [How It Works](#how-it-works)\n- [Getting Started](#getting-started)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Deployment](#deployment)\n- [Security](#security)\n- [ENV](#env)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n\u003cimg src=\"/public/assets/screenshot-profile.PNG\" alt=\"mobile-profile\" /\u003e\n\n## Features\n\n- **End-to-End Encryption**: All messages are encrypted to protect user privacy, ensuring that only the sender and recipient can read them.\n- **Customizable UI**: A clean and user-friendly interface with light customization options for themes and colors.\n- **Multiple Messaging Formats**: Send and receive text, images, videos, and links seamlessly.\n- **Group Messaging**: Communicate with multiple contacts in organized group chats.\n- **Contacts Management**: Store and group contacts for easy access. Use your phone number or create a custom number to communicate.\n- **Phone Number Communication**: Users can communicate via their phone numbers or create a custom number for additional privacy.\n- **Search, Filter, \u0026 Sort**: Find messages or contacts easily with advanced search, filtering, and sorting capabilities.\n- **Notifications**: Get notified about new messages, group chats, or events in real time.\n- **Cross-Platform Syncing**: Sync messages across devices via **webhooks** and **WebSockets** for uninterrupted communication.\n- **Offline Mode with Auto-Sync**: Send messages while offline, and they will automatically be delivered when network access is regained.\n- **Passwordless Login**: Login securely with **email passcodes**, **text message passcodes**, **biometric authentication**, or **passkeys** for a frictionless user experience.\n- **Cross-Platform Support**: Txt Me is a PWA that runs on any device, ensuring compatibility across desktops, tablets, and mobile phones.\n\n## How It Works\n\n- **Client**: The front-end PWA handles all user interactions, including sending/receiving messages, managing contacts, and rendering the UI.\n- **Server**: The back-end server, hosted on GitHub, handles authentication, message encryption/decryption, and message storage. It also manages real-time communication through webhooks and WebSockets.\n\n## Getting Started\n\n### Prerequisites\n\n- Node.js\n- Git\n- Your preferred package manager (npm/yarn)\n\n### Installation\n\n1. **Clone the Repository:**\n\n   ```bash\n   git clone https://github.com/RyanLarge13/Txt-Me.git\n   cd txt-me\n   ```\n\n2. **Install Dependencies:**\n\n   ```bash\n   npm install\n   ```\n\n3. **Start the Server:**\n\n   Follow the server setup instructions from the [server repository](https://github.com/RyanLarge13/Txt-Me-Server).\n\n4. **Run the Application:**\n\n   ```bash\n   npm start\n   ```\n\n5. **Build for Production:**\n\n   ```bash\n   npm run build\n   ```\n\n### Deployment\n\nTxt Me can be deployed on any web server that supports PWAs. For cross-platform syncing, ensure that WebSocket connections and webhook endpoints are correctly configured.\n\n## Security\n\nTxt Me uses **end-to-end encryption** for all messages. User credentials are securely stored, and passwordless login methods like **email/text passcodes**, **biometrics**, and **passkeys** ensure both security and ease of use.\n\n## ENV\n\n```\nVITE_API_SOCKET_URL = ws://localhost:8080/\nVITE_API_URL = http://localhost:8080\n```\n\n## Contributing\n\nFeel free to contribute to the project! Follow these steps to contribute:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature/YourFeature`).\n3. Commit your changes (`git commit -m 'Add YourFeature'`).\n4. Push to the branch (`git push origin feature/YourFeature`).\n5. Open a pull request.\n\n## License\n\nThis project is licensed under the MIT License - see the [MIT LICENSE](LICENSE) file for details.\n\n## Contact\n\nFor any inquiries or questions, please reach out at [My Email](mailto:ryanlarge@ryanlarge.dev).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanlarge13%2Ftxt-me","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryanlarge13%2Ftxt-me","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanlarge13%2Ftxt-me/lists"}