Summize (Sumzs)

An AI article summarizer.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

Simplify your readings with Summize, an open-source article summarizer that transforms lengthy articles into clear and concise summaries.

The goals of this project were to:

• setup a ReactJS project using Vite
• create a responsive, beautiful UI/UX with a nice touch of glass morphism using Tailwind CSS
• make advanced RTK query API requests that fire on condition
• save history using the local storage
• handle form events and catch errors
• implement copy to clipboard

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Get a free API Key from Rapid API
2. Clone the repo

   git clone https://github.com/your_username_/ai-article-summarizer.git

3. Install NPM packages

   npm install

4. Enter your API in .env

   const VITE_RAPID_API_ARTICLE_KEY = 'ENTER YOUR API';

5. Run the app

   npm run dev

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Helen Gezahegn - gezahegn@ualberta.ca

Project Link: https://github.com/HelenGezahegn/ai-article-summarizer

(back to top)