AI NEWS HUB

Features

• 📲 PWA ready, installable on Android and iOS
• 🔎 Algolia Search, search by all attributes
• 📧 Getform.io contact form with easy setup.
• 📝 Blog ready, easily add your blog posts with MDX
• 🌗 Togglable dark mode
• 💻 SEO ready, option to Add meta description

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can't go back!

If you aren't satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

Getting Started

Pre-requisites (once for a machine)

• Node Installation: Install Node.js [Recommended LTS version]

After successfully installing those dependencies, open this template with any IDE [VS Code recommended], and then open the internal terminal of IDE [VS Code shortcut ctrl/cmd + `]

Requirements

To follow along, you will need:

• Python 3.10 or higher. You can download the latest version of Python from the official website: python.org
• An OpenAI API key. Sign up for an API key at openai.com

Installation

1. Clone the repository

   git clone https://github.com/Ubayed-Bin-Sufian/AI-News-Hub.git
   

2. Navigate to the project directory:

   cd AI-News-Hub
   

3. Install dependencies, this can take a minute

   npm install
   

4. Start the local server

   npm start
   

Your browser should now open and show the app. Otherwise open http://localhost:3000/ in your browser. Editing files will automatically refresh the page.

For Python scripts

1. Create a virtual environment (optional but recommended):

   python3 -m venv env
   source env/bin/activate
   

2. Install the required dependencies:

   pip install -r requirements.txt
   

3. Set up your OpenAI API key:

   • Create a .env file in the project root directory.
   • Add your OpenAI API key to the .env file:

   OPENAI_API_KEY=your_api_key_here
   

Deployment

Production Build

After finishing all the customization, you can create a production build by running this command.

npm run build 

It will create a folder named build with your compiled project inside. After that copy its content into your webroot and you are ready to go.

Deployment using Vercel

• Login/Signup to the Vercel GitHub account.
• Authorize the repository access.
• Configure the custom domain on Vercel. Go through the website by Vercel team and learn deploying using Git.

Built With

• Create-React-App - Used to bootstrap the development
• Material-UI - Material Design components
• React-Router - Routing of the app

Contributing

Show your support by ⭐ the project. Pull requests are always welcome. We'd love to have your helping hand on AI-News-Hub blog!

Make sure that you follow CODE_OF_CONDUCT while contributing and engaging in the discussions.

When contributing, please first discuss the change you wish to make via an issue on this repository before making the actual change.

Reporting Issues

We use GitHub Issues as the official bug tracker for this Template. Please Search existing issues. It’s possible someone has already reported the same problem. If your problem or idea has not been addressed yet, feel free to open a new issue.

Credits

This project exists thanks to all the people who contribute.

License

This project is licensed under the MIT License - see the LICENSE file for details.