Code Monkey home page Code Monkey logo

parashu's Introduction

Parashu πŸͺ“ : Your Ultimate AI-Powered News App

Parashu is an innovative news platform that seamlessly blends Artificial Intelligence with journalism excellence. The backend is powered by Ruby on Rails, providing robust API endpoints, while the frontend is crafted with React to offer an immersive user experience. Parashu allows users to explore news, save articles, and interact with intelligent features that enrich their understanding of the world.

Access the live version of Parashu at https://parashu.vercel.app/.

Get to know about the journey of development of Parashu at out Medium Article β€œParashu: A Journey through AI-Powered News Evolution! πŸš€πŸ“°β€

Features

Intelligent News Management

Parashu offers advanced news management features, allowing users to:

  • User Authentication: Secure user authentication system ensures data privacy.

  • Article Saving: Users can save articles of interest for later reading.

  • AI-Driven Summarization: Utilizes AI to summarize articles for quick insights.

  • News Contextualization: Going Beyond Headlines, Creating Connections. Parashu: Delving Deep into Stories, Crafting Contexts that Resonate Across Cultures.

  • Quizzing Chatbot: Interactive chatbot quizzes users on their knowledge of news articles.

  • Future Prospects: Exciting upcoming features include personalized recommendations, interactive quizzes, and real-time news updates.

    Get the guided tour of our app features

Getting Started

These instructions will guide you through setting up and running Parashu on your local machine for development and testing purposes.

Prerequisites

  • Ruby: Ensure you have Ruby installed. Recommended version: 2.7.4
  • Rails: Install Rails, the backend framework. Recommended version: 6.1.4
  • Node.js: Required for managing JavaScript packages. Recommended version: 14.16.1
  • PostgreSQL: Database system. Recommended version: 13.3

Installation

  1. Clone the repository:

    git clone https://github.com/PreethamNaik12/parashu
    cd parashu-news-app
    
  2. Navigate to the server directory:

    cd server
    
  3. Install Ruby dependencies:

    bundle install
    
  4. Install JavaScript dependencies:

    yarn install
    
  5. Create and migrate the database:

    rails db:create
    rails db:migrate
    
  6. Start the Rails server:

    rails s
    

The Rails backend is now running on http://localhost:3000.

Backend documentation is available in the server folder.

  1. Navigate to the client directory:

    cd client
    
  2. Install JavaScript dependencies:

     npm install
    
  3. Start the React server:

    npm start
    

The React frontend is now running on http://localhost:3001.

Frontend documentation is available in the client folder.

API Documentation

For API documentation and endpoints, refer to the API Documentation.

Deployment

Server and the Client have to depoloyed seperately. Parashu Server can be easily deployed to cloud platforms like Render, Heroku or AWS.Parashu Client can be deployed to cloud platforms like Vercel, Netlify or Github Pages. Ensure to set up the necessary environment variables (such as API keys) in your production environment.

Support and Contributions

For bug reports, issues, or feature requests, please create an issue.


Parashu - Where Artificial Intelligence Meets Journalism Excellence.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.