Welcome to Briefing Buzz! This app was created using Expo, a free and open-source platform for building React Native apps. It utilizes a server built with Flask for backend functionality, offering the latest news articles and providing article summarization to save you time and enhance your reading experience.
- Getting Started
- Prerequisites
- API Keys
- Installation
- Running the Server
- Running the App
- Built With
- Contributing
- Project Motive
Please note that this app is still a work in progress. The Brief feature needs final refinements, and the app may not have a polished user interface. We are actively working on improving the app's design and user experience, and appreciate any feedback or suggestions you may have.
You may encounter bugs or unexpected behavior while using this app!
To get started with this project, clone the repository to your local machine and install the necessary dependencies.
git clone https://github.com/ObaidaHY/Briefing-Buzz.git
cd briefing-buzz
npm install
# or
yarn installBefore you can run this app, you'll need to install Expo CLI. You can do this by running the following command:
npm install -g expo-cli
# or
yarn global add expo-cliYou'll also need to install the required Python dependencies for the server. Make sure you have Python 3 and pip installed. Then, navigate to the Server directory and run the following command:
pip3 install -r pythonReq.txtTo use Briefing Buzz, you will need to obtain API keys for TWO services: ONE AI and News API.
- To get a ONE AI API key, visit the ONE AI website and sign up for an account. Once you have signed up, you can access your API key in the account settings section.
- To get a News API key, visit the News API website and sign up for an account. Once you have signed up, you can access your API key in the dashboard section.
Once you have obtained both API keys, create a new folder called config in the root directory of the project and define a config.js file in that folder with the API keys, like this:
export const API_KEY = "insert your News API key here";
export const ONEAI_API_KEY = "insert your ONEAI API key here";
Replace with your actual API keys.
Also make sure to replace <your-oneai-api> with your actual ONEAI API key in the main.py file.
Once you have cloned the repository and installed the necessary dependencies, you can run the app on your local machine.
npm start
# or
yarn startThis will start the Expo development server and open the app in your default browser. You can then use the Expo app on your mobile device to scan the QR code and view the app.
Before running the app, you need to start the server. In a separate terminal, navigate to the Server directory and run the following command:
python main.pyOr simply run the main.py python file.
This will start the Flask server and enable the backend functionality of the app.
To run the app on your mobile device, you'll need to download the Expo app from the App Store or Google Play. Once you have the Expo app installed, you can scan the QR code generated by npm start or yarn start and view the app.
- Expo - A free and open-source platform for building React Native apps.
- React Native - A JavaScript framework for building native mobile apps.
- React Navigation - A routing and navigation library for React Native apps.
- Flask - A micro web framework for building server-side applications.
... and more (see package.json for full list).
If you would like to contribute to this project, please open an issue or pull request on the GitHub repository.
The motive behind building Briefing Buzz is to provide a convenient solution for individuals who want to stay up to date with the latest news and articles while saving time. It is common to come across numerous articles, but reading them all can be time-consuming. Briefing Buzz offers the latest news articles and a unique feature of article summarization. By providing summarized versions of articles in just a few lines, Briefing Buzz enables users to quickly grasp the key points and decide which articles to explore further. This saves time and enhances the reading experience, making it easier to stay informed in today's fast-paced world.
We believe that Briefing Buzz can be a valuable tool for anyone seeking a concise yet comprehensive overview of current news and articles. We are continuously working to improve the app's design, user experience, and article summarization feature. We appreciate any feedback or suggestions you may have as we strive to make Briefing Buzz an indispensable app for staying informed efficiently.