Skip to content

Latest commit

 

History

History
97 lines (74 loc) · 3.19 KB

README.md

File metadata and controls

97 lines (74 loc) · 3.19 KB
Raw

Briefify

Welcome to Briefify! This application is designed to help users quickly and accurately summarize lengthy texts using the power of AI.

Features

  • AI-Powered Summarization: Leverages advanced AI technology to generate concise and precise summaries.
  • Bullet Point Summaries: Summaries are provided in easy-to-read bullet points.
  • Responsive Design: The application is accessible on any device, whether you’re using a desktop, tablet, or smartphone.
  • User-Friendly Interface: Simple and intuitive design for a seamless user experience.
  • Fast and Efficient: Generates summaries in seconds, regardless of text length

Tech Stack

  • React.js: Used as the frontend framework for building the user interface of the platform, providing a responsive and interactive experience.
  • Tailwind CSS: Used for styling the user interface, offering customizable and reusable styling classes.
  • Node.js & Express: Backend server to handle API requests and integrate with the summarization logic.
  • Cohere ai & api's: Utilizes Cohere's ai model & api key for text summarization.
  • Render: Platform used for backend deployment, providing seamless deployment and hosting services.
  • Vercel: Platform used for deployment and hosting, providing a seamless deployment process and reliable hosting services.

Getting Started

To get started with the project, follow these steps:

Backend

  1. Clone the backend repository: 
    git clone https://github.com/aryyan0701/text-summarization-backend.git
  2. Navigate into the project directory: 
    cd your_project_name
  3. Install dependencies: 
    npm install
  4. Start the development server: 
    npm start

Frontend

  1. Clone the backend repository: 
    git clone https://github.com/aryyan0701/text-summarization-frontend.git
  2. Navigate into the project directory: 
    cd your_project_name
  3. Install dependencies: 
    npm install
  4. Start the development server: 
    REACT_APP_BACKEND_URL=Your_live_backend_url
  5. Start the development server: 
    npm run dev

Usage

  • Enter the text you want to summarize in the input box.
  • Click on the "Summarize" button to generate the summary.
  • View the summarized text in bullet point format below the input box.
  • Clear the input text to remove the summary and start over.

Contributors

  • Aryan - Project Lead & Developer

License

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

Acknowledgements

  • React.js community for providing a powerful frontend library for building user interfaces.
  • Tailwind CSS for offering a utility-first CSS framework for rapid prototyping and styling.
  • Cohere for providing the powerful AI model for text summarization.
  • Render for backend deployment and hosting services.
  • Vercel for frontend deployment and hosting services.

Further Help

  • For more information on using React.js, Tailwind CSS, or Node.js, refer to their official documentation.
  • If you need assistance with the project, feel free to reach out to the project lead or contributors.

Thank You ..!!