Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ladunjexa/reactjs18-summarizer
well-designed Article Summarizer Web Application built with React & Redux.js using OpenAI's GPT-4 model powered by Rapid API 🤖
https://github.com/ladunjexa/reactjs18-summarizer
ai-summarizer openai-gpt4 rapid-api react-redux reduxjs-toolkit tailwindcss vitejs-react
Last synced: 10 days ago
JSON representation
well-designed Article Summarizer Web Application built with React & Redux.js using OpenAI's GPT-4 model powered by Rapid API 🤖
- Host: GitHub
- URL: https://github.com/ladunjexa/reactjs18-summarizer
- Owner: ladunjexa
- License: mit
- Created: 2023-04-21T20:49:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-13T18:29:54.000Z (6 months ago)
- Last Synced: 2024-05-13T19:45:09.965Z (6 months ago)
- Topics: ai-summarizer, openai-gpt4, rapid-api, react-redux, reduxjs-toolkit, tailwindcss, vitejs-react
- Language: JavaScript
- Homepage: https://reactjs18-summarizer.vercel.app/
- Size: 2.18 MB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GPT-4 Summarizer Web
well-designed article summarizer web application using openAI's GPT-4 model powered by Rapid API - built with React & Redux.js
View Demo
·
Documentation
·
Report Bug
·
Request Feature
# :notebook_with_decorative_cover: Table of Contents
- [About the Project](#star2-about-the-project)
* [Folder Structure](#bangbang-folder-structure)
* [Tech Stack](#space_invader-tech-stack)
- [Getting Started](#toolbox-getting-started)
* [Environment Variables](#key-environment_variables)
* [Installation](#gear-installation)
* [Run Locally](#running-run-locally)
- [Contributing](#wave-contributing)
- [License](#warning-license)
- [Contact](#handshake-contact)
- [Acknowledgements](#gem-acknowledgements)
## :star2: About the Project
This repository houses a well-designed Article Summarizer Web Application built with React & Redux.js using OpenAI's GPT-4 model powered by Rapid API 🤖
### :bangbang: Folder Structure
Here is the folder structure of GPT4 Summarizer Web.
```bash
GPT4-Summarizer-Web/
|- public/
|- src/
|-- assets/
|-- {...}.svg
|-- index.js
|-- components/
|-- Demo.jsx
|-- Hero.jsx
|-- index.js
|-- services/
|-- article.js
|-- store.js
|-- App.css
|-- App.jsx
|-- main.jsx
|- .env
|- .eslintrc.cjs
|- index.html
|- package.json
|- postcss.config.js
|- tailwind.config.js
|- vite.config.js
```
### :space_invader: Tech Stack
[](https://skillicons.dev)
## :toolbox: Getting Started
### :key: Environment Variables
In order to use this GPT4 Summarizer Webapp you have to add some environment variables to .env file,
create `.env` file in root folder & add the following environment variable:
```env
VITE_RAPID_API_KEY=
```
### :gear: Installation
#### Step 1:
Download or clone this repo by using the command below:
```bash
https://github.com/ladunjexa/GPT4-Summarizer-Web.git
```
#### Step 2:
This webapp using NPM (Node Package Manager), therefore, make sure that Node.js is installed by execute the following command in console:
```bash
node -v
```
#### Step 3:
In root folder execute the following command to get the required packages:
```bash
npm install
```
### :running: Run Locally
#### Step 1:
Go to root folder and execute the following command in order to run the webapp:
```bash
npm run dev
```
## :wave: Contributing
Contributions are always welcome!
See [`contributing.md`](https://contributing.md/) for ways to get started.
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
## :warning: License
Distributed under the MIT License. See [LICENSE.txt](https://github.com/ladunjexa/GPT4-Summarizer-Web/blob/main/LICENSE) for more information.
## :handshake: Contact
Liron Abutbul - [@lironabutbul6](https://twitter.com/lironabutbul6) - [@ladunjexa](https://t.me/ladunjexa)
Project Link: [https://github.com/ladunjexa/GPT4-Summarizer-Web](https://github.com/ladunjexa/GPT4-Summarizer-Web)
## :gem: Acknowledgements
This section used to mention useful resources and libraries that used in the GPT4 Summarizer Webapp:
#### client-side
- [Vite.js](https://vitejs.dev/)
- [React](https://react.dev/)
- [Redux Toolkit](https://redux-toolkit.js.org/)
- [React Redux](https://react-redux.js.org/)
- [TailwindCSS](https://tailwindcss.com/)
- [Rapid API](https://rapidapi.com/)
- [Google Fonts](https://fonts.google.com/)
- #JSMastery