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
馃摂 Table of Contents
馃専 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 馃
鈥硷笍 Folder Structure
Here is the folder structure of GPT4 Summarizer Web.
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
馃懢 Tech Stack
馃О Getting Started
馃攽 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:
VITE_RAPID_API_KEY=<RAPID_API_KEY>
鈿欙笍 Installation
Step 1:
Download or clone this repo by using the command below:
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:
node -v
Step 3:
In root folder execute the following command to get the required packages:
npm install
馃弮 Run Locally
Step 1:
Go to root folder and execute the following command in order to run the webapp:
npm run dev
馃憢 Contributing
Contributions are always welcome!
See 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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
鈿狅笍 License
Distributed under the MIT License. See LICENSE.txt for more information.
馃 Contact
Liron Abutbul - @lironabutbul6 - @ladunjexa
Project Link: https://github.com/ladunjexa/GPT4-Summarizer-Web
馃拵 Acknowledgements
This section used to mention useful resources and libraries that used in the GPT4 Summarizer Webapp:
client-side
- Vite.js
- React
- Redux Toolkit
- React Redux
- TailwindCSS
- Rapid API
- Google Fonts
- #JSMastery