Skip to content

jonathanung/chaoscribe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chaoscribe - ChaosHacks2024

Chaoscribe is a project developed for ChaosHacks2024. This project leverages the power of AI to classify news articles on demand. It's built using Next.js, Tailwind CSS, and FlowBite for the frontend, with FastAPI and Postgres for the backend, GPT-4 for AI capabilities, and NewsAPI for all of the data.

Features

  • AI-optimized news article classification using GPT-4 API
  • Responsive design using Tailwind CSS for an optimal viewing experience on various devices
  • Easy-to-use interface built with Next.js and FlowBite for smooth navigation and interaction
  • Fast and efficient backend powered by FastAPI and Postgres for handling requests and data storage
  • Integration with NewsAPI for accessing a wide range of news articles from different sources

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (version 12 or higher)
  • npm (Node Package Manager, version 6 or higher)
  • Python 3.7+ (for FastAPI)
  • PostgreSQL (for the database)

Installation

To set up the project locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/jonathanung/chaoscribe.git
    cd chaoscribe/chaoscribe
    
  2. Install the required packages:

    npm install
    
  3. Run the development server:

    npm run dev
    
  4. Open your browser and navigate to http://localhost:3000/ to view the application.

Technologies Used

  • Frontend:

    • Next.js - A React framework for building web applications.
    • Tailwind CSS - A utility-first CSS framework.
    • FlowBite - A set of UI components and design tools.
    • React.js - A JavaScript library for building user interfaces.
    • axios - A promise-based HTTP client for the browser and Node.js.
  • AI:

    • GPT-4 - The latest generation of the Generative Pre-trained Transformer by OpenAI.
  • Backend:

    • FastAPI - A modern, fast (high-performance) web framework for building APIs with Python 3.7+.
    • Postgres - An open source object-relational database system.
  • Data Source:

    • NewsAPI - A simple HTTP REST API for searching and retrieving live articles from all over the web.

About

CHAOSHACKS 2024

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published