https://github.com/pushkarm029/truetext
TrueText is your guardian against SMS scams and your source for the latest news. In a world where SMS messages can hide potential scams and spam, TrueText is your vigilant guardian that identifies scams, fraud, and spam to provide immediate alerts.
https://github.com/pushkarm029/truetext
android api flask ios machine-learning natural-language-processing python react-native restful-api sklearn
Last synced: 2 months ago
JSON representation
TrueText is your guardian against SMS scams and your source for the latest news. In a world where SMS messages can hide potential scams and spam, TrueText is your vigilant guardian that identifies scams, fraud, and spam to provide immediate alerts.
- Host: GitHub
- URL: https://github.com/pushkarm029/truetext
- Owner: Pushkarm029
- Created: 2023-10-16T06:57:16.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-23T10:23:12.000Z (over 2 years ago)
- Last Synced: 2025-04-03T07:44:49.393Z (about 1 year ago)
- Topics: android, api, flask, ios, machine-learning, natural-language-processing, python, react-native, restful-api, sklearn
- Language: Jupyter Notebook
- Homepage:
- Size: 3.35 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# True Text
#### TrueText: Your Guardian Against SMS Scams and Your Source for Latest News
In a world where SMS messages can hide potential scams and spam, From fake electricity bill alerts to suspicious lottery winnings and phishing scams, the world of SMS is fraught with potential pitfalls. Unsuspecting users often fall victim to scams and spam that threaten their privacy, security, and peace of mind. TrueText is your vigilant guardian. Our app doesn't send or receive messages but loads your SMS inbox, identifying scams, fraud, and spam to provide immediate alerts and educational resources, ensuring a safer SMS experience. TrueText prioritizes your privacy, respecting your data security while offering the latest news through a dedicated section, keeping you informed on global events and personalized interests. Join TrueText to protect yourself and stay well-informed, all within a single app.
## Project Setup
### Prerequisites
Before you start, ensure that you have the following installed on your local machine:
- Node.js and npm (Node Package Manager)
- Git
### Clone the Repository
1. Fork the repository: Click the "Fork" button on the top right of the [TrueText GitHub repository](https://github.com/Pushkarm029/TrueText) to create a fork under your GitHub account.
2. Clone the forked repository to your local machine:
```bash
git clone git@github.com:YourGitHubUsername/TrueText.git
cd TrueText
```
### Frontend Setup
#### Install Dependencies
In the project directory, run the following command to install project dependencies:
```bash
npm install
```
#### Start the Development Server
To start the development server and run your React Native project, use the following command:
```bash
npx react-native start
```
### Backend Setup
#### Install Dependencies
```bash
# Navigate to the server directory
cd server
# To install the required packages, run the following command:
pip install -r requirements.txt
# Run the development server
python app.py
# The server will run on http://localhost:5000
```
## Contribution Guidelines
We welcome contributions from the community to improve TrueText. To contribute, please follow these guidelines:
### Branching
1. Create a new branch for your contribution. Be sure to give it a descriptive and concise name:
```bash
git checkout -b feature/your-feature-name
```
2. Make your changes in the new branch.
### Committing
3. Commit your changes with a clear and concise commit message:
```bash
git commit -m "Add your description here"
```
### Keeping Your Fork Up to Date
4. Before pushing your changes, ensure that your branch is up to date with the latest changes from the original repository:
```bash
git pull origin main
```
5. Push your changes to your forked repository:
```bash
git push origin feature/your-feature-name
```
### Creating a Pull Request (PR)
6. Go to your forked repository on GitHub and create a new Pull Request (PR) from your branch to the original project's `main` branch.
7. Describe your changes in the PR, explaining what the changes aim to achieve.
### Review and Approval
8. Your PR will be reviewed, and there may be discussions and suggestions for improvement. Be open to feedback and make any necessary changes.
9. Once your PR is approved, it will be merged into the original project. Your contribution will be acknowledged in the project's history.
### Keeping Your Fork in Sync
10. To keep your fork up to date with the original repository, regularly sync with the original project:
```bash
git fetch upstream
git checkout main
git merge upstream/main
```
Congratulations! You've successfully contributed to the TrueText project. Thank you for your valuable input.